Azure Developer CLI スキーマ リファレンス

azure.yaml ファイルは、Azure Developer CLI (azd) プロジェクトの構成ファイルです。 プロジェクトのルートに配置して、アプリケーションを構成するサービス、Azure リソース、インフラストラクチャ、フック、CI/CD パイプラインを定義します。 azd up、azd provision、azd deployなどのコマンドを実行すると、CLI によってこのファイルが読み取られ、アプリの構造と Azure へのデプロイ方法が理解されます。

この記事は、 azure.yaml スキーマの完全なリファレンスです。 azd テンプレートの概要については、「Azure Developer CLI テンプレートの概要」を参照してください。

見本

azd テンプレートのazure.yaml ファイルの一般的な例を次に示します。 実際の例については、ToDo NodeJs Mongo テンプレートのazure.yamlを参照してください。

name: yourApp
metadata:
  template: yourApp@0.0.1-beta
services:
  web:
    project: ./src/web
    dist: build
    language: js
    host: appservice
  api:
    project: ./src/api
    language: js
    host: appservice

最上位のプロパティ

name

(文字列、必須) アプリケーション名。 使用できるのは、小文字、数字、ハイフン (-) のみです。 名前の最初と最後は、文字か数字にする必要があります。 最小長: 2 文字。

name: my-app

resourceGroup

(文字列) Azure リソース グループの名前。 指定すると、インフラストラクチャ のプロビジョニングに使用されるリソース グループ名がオーバーライドされます。 環境変数の置換をサポートします。 3 ~ 64 文字にする必要があります。

resourceGroup: rg-my-app-${AZURE_ENV_NAME}

metadata

(オブジェクト) アプリケーション テンプレートに関するメタデータ。

metadata:
  template: todo-nodejs-mongo@0.0.1-beta

infra

(オブジェクト) Azure インフラストラクチャ プロビジョニングの追加の構成を提供します。

infra.layers

(オブジェクトの配列) Azure インフラストラクチャのプロビジョニング レイヤーを定義します。 各レイヤーは、プロビジョニングの独立した単位を表します。

infra:
  provider: bicep
  layers:
    - name: core
      path: ./infra/core
    - name: services
      path: ./infra/services
      hooks:
        postprovision:
          shell: sh
          run: ./scripts/post-provision.sh

IaC プロバイダーとしての Terraform のサンプル

Bicep の代わりに Terraform を使用するには、 provider を terraform に設定します。 詳細については、「 IaC プロバイダーとして Terraform を使用する」を参照してください。

name: yourApp-terraform
metadata:
  template: yourApp-terraform@0.0.1-beta
services:
  web:
    project: ./src/web
    dist: build
    language: js
    host: appservice
  api:
    project: ./src/api
    language: js
    host: appservice
infra:
  provider: terraform

services

(オブジェクト) アプリケーションを構成するサービスの定義です。 各キーはサービス名であり、値はサービス構成オブジェクトです。

サービスのプロパティ

ホストの種類

host プロパティは、サービスの実装に使用される Azure リソースの種類を決定し、有効なその他のプロパティを制御します。

ai.endpoint 設定

(オブジェクト、 host が ai.endpointされている場合に必要) Azure AI オンライン エンドポイントデプロイ用の追加の構成を提供します。

AI コンポーネントの構成

AI デプロイ構成

AI コンポーネント構成からすべてのプロパティを継承します。

services:
  myendpoint:
    project: ./src/endpoint
    host: ai.endpoint
    config:
      workspace: my-ai-project
      deployment:
        path: ./deployment
        environment:
          MODEL_NAME: ${AZURE_OPENAI_MODEL}

docker

(オブジェクト) サービスの Docker 構成。 コンテナー (containerapp、 aks、 ai.endpoint、 azure.ai.agent) をサポートするホストにのみ適用されます。

k8s

(オブジェクト) Azure Kubernetes Service (AKS) 構成オプション。 hostがaksされている場合にのみ有効です。

デプロイ構成

サービス構成

イングレス構成

Helm config

repositories 配列項目:

releases 配列項目:

Kustomize config

サービス フック

サービス レベル フックは、サービス ライフサイクル イベント中に実行されます。 フックは、 pre または postでプレフィックスが付いたサービス イベント名と一致する必要があります。 パスを指定するときは、サービス パスに対する相対パスにする必要があります。 詳細については、「コマンドとイベント フック を使用して Azure Developer CLI ワークフローをカスタマイズする」を参照してください。

サポートされているサービス フック: prerestore、 postrestore、 prebuild、 postbuild、 prepackage、 postpackage、 prepublish、 postpublish、 predeploy、 postdeploy。

各フックは、 フック定義 形式を使用します。

サービス のサンプル

Docker オプションを使用したコンテナー アプリ

services:
  api:
    project: ./src/api
    language: js
    host: containerapp
    docker:
      path: ./Dockerfile
      context: ../
  web:
    project: ./src/web
    language: js
    host: containerapp
    docker:
      remoteBuild: true

事前構築済みイメージからの Container Apps

services:
  api:
    image: myregistry.azurecr.io/myapp:latest
    host: containerapp

AKS とサービス レベル フック

services:
  web:
    project: ./src/web
    dist: build
    language: js
    host: aks
    hooks:
      postdeploy:
        shell: sh
        run: azd env set REACT_APP_WEB_BASE_URL ${SERVICE_WEB_ENDPOINT_URL}
  api:
    project: ./src/api
    language: js
    host: aks
    k8s:
      ingress:
        relativePath: api
    hooks:
      postdeploy:
        shell: sh
        run: azd env set REACT_APP_API_BASE_URL ${SERVICE_API_ENDPOINT_URL}

resources

(オブジェクト) アプリケーションによって使用される Azure リソースの定義。 各キーはリソース名であり、値はリソース構成オブジェクトです。 リソースは、 uses プロパティを使用してサービスによって参照できます。

一般的なリソース プロパティ

リソースの種類

type プロパティは、Azure リソースの種類を決定し、使用できる追加のプロパティを制御します。

プロパティの host.appservice

runtime オブジェクト：

resources:
  web:
    type: host.appservice
    port: 8080
    runtime:
      stack: node
      version: 22-lts
    uses:
      - db

プロパティの host.containerapp

プロパティの ai.openai.model

model オブジェクト：

resources:
  chatModel:
    type: ai.openai.model
    model:
      name: gpt-4o
      version: "2024-08-06"

プロパティの ai.project

models 配列項目:

sku オブジェクト：

プロパティの ai.search

プロパティの db.cosmos

containers 配列項目:

プロパティの messaging.eventhubs

プロパティの messaging.servicebus

プロパティの storage

プロパティの keyvault

リソースのサンプル

resources:
  db:
    type: db.postgres
  cache:
    type: db.redis
  chatModel:
    type: ai.openai.model
    model:
      name: gpt-4o
      version: "2024-08-06"
  web:
    type: host.containerapp
    port: 3100
    uses:
      - db
      - chatModel

pipeline

(オブジェクト) 継続的インテグレーション パイプラインの定義。

pipeline:
  provider: azdo
  variables:
    - CUSTOM_SETTING
  secrets:
    - API_KEY

hooks

(オブジェクト) コマンド レベルのフック。 フックは、スクリプト azd 実行するタイミングに応じて、pre または post でプレフィックスが付いたコマンド名と一致する必要があります。 パスを指定するときは、プロジェクト パスに対する相対パスにする必要があります。 詳細については、「コマンドとイベント フック を使用して Azure Developer CLI ワークフローをカスタマイズする」を参照してください。

サポートされているコマンド フック: preprovision、 postprovision、 preinfracreate、 postinfracreate、 preinfradelete、 postinfradelete、 predown、 postdown、 preup、 postup、 prepackage、 postpackage、 prepublish、 postpublish、 predeploy、 postdeployprerestore、 postrestore。

各フックは、 フック定義 形式を使用します。

hooks:
  preprovision:
    shell: sh
    run: ./scripts/setup.sh
  postdeploy:
    shell: sh
    run: azd env set APP_URL ${SERVICE_WEB_ENDPOINT_URL}

フック定義

フックには、1 つのフック オブジェクトまたはフック オブジェクトの配列を指定できます。 各フック オブジェクトには、次のプロパティがあります。

フック実行プログラムの構成

config プロパティは、kind値に応じて異なるプロパティを受け入れます。

JavaScript と TypeScript (js、 ts) の構成

Python 構成

.NET (dotnet) 構成

シェル (sh、 pwsh) 構成

シェル Executor は現在、 config プロパティをサポートしていません。

フックのサンプル

プラットフォーム固有のフック

hooks:
  preprovision:
    windows:
      shell: pwsh
      run: ./scripts/setup.ps1
    posix:
      shell: sh
      run: ./scripts/setup.sh

種類付きの Python フック

hooks:
  postprovision:
    kind: python
    run: ./scripts/seed-data.py
    dir: ./scripts
    config:
      virtualEnvName: .venv

1 つのイベントに対する複数のフック

hooks:
  postprovision:
    - shell: sh
      run: ./scripts/step1.sh
    - shell: sh
      run: ./scripts/step2.sh

requiredVersions

(オブジェクト) 必要なバージョンの azd と拡張機能の追加の構成を提供します。

requiredVersions:
  azd: ">= 0.6.0-beta.3"
  extensions:
    azure.ai.agents: ">=1.0.0"
    my-extension: latest

state

(オブジェクト) 状態管理の追加の構成を提供します。

state.remote

Azure Blob Storage の構成

state:
  remote:
    backend: AzureBlobStorage
    config:
      accountName: mystorageaccount
      containerName: azd-state

platform

(オブジェクト) Azure デベロッパー センターなどのプラットフォーム固有の機能の追加構成を提供します。

デベロッパー センターの構成

typeがdevcenterされている場合に使用できます。

platform:
  type: devcenter
  config:
    name: my-devcenter
    project: my-project
    catalog: my-catalog
    environmentDefinition: my-env-def
    environmentType: dev

workflows

(オブジェクト)azd up動作のオーバーライドなど、ワークフローの追加の構成を提供します。

ワークフローのステップ

up ワークフローは、steps配列を受け取ります (または、配列として直接指定することもできます)。 各ステップでは、 azd コマンドが実行されます。

ワークフロー ステップの順序を構成する

次のazure.yaml ファイルでは、azd upの既定の動作が変更され、azd provision ステップの後にazd packageステップが移動されます。 このアプローチは、ビルドまたはパッケージ化プロセス中にリソースの URL を知る必要があるシナリオで使用します。

name: todo-nodejs-mongo
metadata:
  template: todo-nodejs-mongo@0.0.1-beta
workflows:
  up:
    steps:
      - azd: provision
      - azd: package
      - azd: deploy --all

cloud

(オブジェクト) Azure Government などのソブリン クラウドにデプロイするための追加の構成を提供します。 既定のクラウドは AzureCloudです。

cloud:
  name: AzureUSGovernment

ヘルプを要求する

バグの報告、ヘルプの要求、または Azure Developer CLI の新機能の提案方法については、のトラブルシューティングとサポートの に関するページを参照してください。

次の手順

• コマンド フックとイベント フックを使用してワークフローをカスタマイズする
• Azure Developer CLI テンプレートの概要
• IaC プロバイダーとして Terraform を使用する
• 環境変数の管理