Azure Developer CLI-Schemareferenz

Die azure.yaml Datei ist die Konfigurationsdatei für Azure Developer CLI(azd)-Projekte. Platzieren Sie es im Stammverzeichnis Ihres Projekts, um die Dienste, Azure-Ressourcen, Infrastruktur, Hooks und CI/CD-Pipeline zu definieren, aus der Ihre Anwendung besteht. Wenn Sie Befehle wie azd up, azd provisionoder azd deploy, die CLI ausführen, liest die CLI diese Datei, um die Struktur Ihrer App zu verstehen und wie Sie sie in Azure bereitstellen.

Dieser Artikel ist eine vollständige Referenz für das Azure.yaml-Schema. Informationen zu den ersten Schritten mit azd Vorlagen finden Sie in der Übersicht über Azure Developer CLI-Vorlagen.

Probe

Nachfolgend sehen Sie ein generisches Beispiel für eine azure.yaml Datei für eine azd Vorlage. Ein Beispiel für eine echte Welt finden Sie in der Vorlage "ToDo NodeJs Mongo":For a real-world, see the azure.yaml from the ToDo NodeJs Mongo template:

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

Eigenschaften der obersten Ebene

name

(Zeichenfolge, erforderlich) Der Anwendungsname. Nur Kleinbuchstaben, Zahlen und Bindestriche (-) sind zulässig. Der Name muss mit einem Buchstaben oder einer Ziffer beginnen und enden. Mindestlänge: 2 Zeichen.

name: my-app

resourceGroup

(Zeichenfolge) Name der Azure-Ressourcengruppe. Wenn angegeben, überschreibt der Ressourcengruppenname, der für die Infrastrukturbereitstellung verwendet wird. Unterstützt die Ersetzung von Umgebungsvariablen. Muss zwischen 3 und 64 Zeichen bestehen.

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

metadata

(Objekt) Metadaten zur Anwendungsvorlage.

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

infra

(Objekt) Stellt zusätzliche Konfiguration für die Bereitstellung der Azure-Infrastruktur bereit.

infra.layers

(Array von Objekten) Definiert Bereitstellungsebenen für die Azure-Infrastruktur. Jede Ebene stellt eine unabhängige Bereitstellungseinheit dar.

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

Terraform als IaC-Anbieterbeispiel

Um Terraform anstelle von Bicep zu verwenden, legen Sie die provider Auf .terraform Weitere Informationen finden Sie unter Verwenden von Terraform als IaC-Anbieter.

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

(Objekt) Definition der Dienste, die die Anwendung umfassen. Jeder Schlüssel ist ein Dienstname, und der Wert ist ein Dienstkonfigurationsobjekt.

Diensteigenschaften

Hosttypen

Die host Eigenschaft bestimmt den Typ der Azure-Ressource, die für die Dienstimplementierung verwendet wird, und steuert, welche anderen Eigenschaften gültig sind.

ai.endpoint Konfiguration

(Objekt, erforderlich) hostai.endpoint Stellt zusätzliche Konfiguration für die Bereitstellung von Azure AI-Onlineendpunkten bereit.

AI-Komponentenkonfiguration

KI-Bereitstellungskonfiguration

Erbt alle Eigenschaften aus der AI-Komponentenkonfiguration, plus:

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

docker

(Objekt) Docker-Konfiguration für einen Dienst. Gilt nur für Hosts, die Container unterstützen (containerapp, aks, ai.endpoint, azure.ai.agent).

k8s

(Objekt) Azure Kubernetes Service (AKS)-Konfigurationsoptionen. Nur gültig, wenn host es sich um aks.

Bereitstellungskonfiguration

Dienstkonfiguration

Ingress-Konfiguration

Helm-Konfiguration

repositories Arrayelemente:

releases Arrayelemente:

Kustomize-Konfiguration

Service Hooks

Hooks auf Dienstebene werden während Dienstlebenszyklusereignissen ausgeführt. Hooks sollten mit pre dienstereignisnamen übereinstimmen, die mit dem Präfix oder post. Bei der Angabe von Pfaden sollten sie relativ zum Dienstpfad sein. Weitere Informationen finden Sie unter Anpassen Ihrer Azure Developer CLI-Workflows mithilfe von Befehls- und Ereignishaken.

Unterstützte Diensthaken: prerestore, , postrestore, postbuildprebuild, prepackage, postpackageprepublish, postpublish, . predeploypostdeploy

Jeder Hook verwendet das Hook-Definitionsformat .

Dienstbeispiele

Container-Apps mit Docker-Optionen

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 aus einem vordefinierten Image

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

AKS mit Dienstebenen-Hooks

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

(Objekt) Definition der von der Anwendung verwendeten Azure-Ressourcen. Jeder Schlüssel ist ein Ressourcenname, und der Wert ist ein Ressourcenkonfigurationsobjekt. Ressourcen können über die uses Eigenschaft von Diensten referenziert werden.

Allgemeine Ressourceneigenschaften

Ressourcentypen

Die type Eigenschaft bestimmt die Art der Azure-Ressource und steuert, welche zusätzlichen Eigenschaften verfügbar sind.

host.appservice-Eigenschaften

runtime Objekt:

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

host.containerapp-Eigenschaften

ai.openai.model-Eigenschaften

model Objekt:

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

ai.project-Eigenschaften

models Arrayelemente:

sku Objekt:

ai.search-Eigenschaften

db.cosmos-Eigenschaften

containers Arrayelemente:

messaging.eventhubs-Eigenschaften

messaging.servicebus-Eigenschaften

storage-Eigenschaften

keyvault-Eigenschaften

Ressourcenbeispiel

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

(Objekt) Definition der kontinuierlichen Integrationspipeline.

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

hooks

(Objekt) Hooks auf Befehlsebene. Hooks sollten azd Befehlsnamen mit dem Präfix pre oder post übereinstimmen, je nachdem, wann das Skript ausgeführt werden soll. Bei der Angabe von Pfaden sollten sie relativ zum Projektpfad sein. Weitere Informationen finden Sie unter Anpassen Ihrer Azure Developer CLI-Workflows mithilfe von Befehls- und Ereignishaken.

Unterstützte Befehlshaken: preprovision, , postprovision, preinfracreate, postinfracreate, preinfradelete, postinfradelete, , predown, postdownpreup, postup, postpackageprerestoreprepublishprepackagepostpublishpredeploypostdeploy. postrestore

Jeder Hook verwendet das Hook-Definitionsformat .

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

Hook-Definition

Ein Hook kann ein einzelnes Hook-Objekt oder ein Array von Hook-Objekten sein. Jedes Hook-Objekt verfügt über die folgenden Eigenschaften:

Konfiguration des Hook-Executors

Die config Eigenschaft akzeptiert je nach kind Wert unterschiedliche Eigenschaften.

JavaScript und TypeScript (js, ts) config

Python-Konfiguration

.NET (dotnet) config

Shell -Konfiguration (sh, pwsh)

Shell-Executoren unterstützen config derzeit keine Eigenschaften.

Hook-Beispiele

Plattformspezifische Hooks

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

Python-Hook mit Art

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

Mehrere Hooks für ein einzelnes Ereignis

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

requiredVersions

(Objekt) Stellt zusätzliche Konfiguration für erforderliche Versionen und azd Erweiterungen bereit.

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

state

(Objekt) Stellt zusätzliche Konfiguration für die Zustandsverwaltung bereit.

state.remote

Azure Blob Storage-Konfiguration

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

platform

(Objekt) Bietet zusätzliche Konfiguration für plattformspezifische Features wie Azure Dev Center.

Dev Center-Konfiguration

Verfügbar, wenntype:devcenter

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

workflows

(Objekt) Stellt zusätzliche Konfiguration für Workflows bereit, z. B. das Außerkraftsetzungsverhalten azd up .

Workflowschritte

Der up Workflow akzeptiert ein steps Array (oder kann direkt als Array angegeben werden). Jeder Schritt führt einen azd Befehl aus.

Konfigurieren der Workflowschrittreihenfolge

Die folgende azure.yaml Datei ändert das Standardverhalten, azd up um den azd package Schritt nach dem azd provision Schritt zu verschieben. Verwenden Sie diesen Ansatz in Szenarien, in denen Sie die URLs von Ressourcen während des Build- oder Verpackungsprozesses kennen müssen.

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

cloud

(Objekt) Stellt zusätzliche Konfiguration für die Bereitstellung in souveränen Clouds wie Azure Government bereit. Die Standardcloud ist AzureCloud.

cloud:
  name: AzureUSGovernment

Anfordern von Hilfe

Informationen zum Ablegen eines Fehlers, Anfordern von Hilfe oder Vorschlagen eines neuen Features für die Azure Developer CLI finden Sie auf der Seite Problembehandlung und Support.

Nächste Schritte

• Anpassen von Workflows mithilfe von Befehls- und Ereignishaken
• Übersicht über Azure Developer CLI-Vorlagen
• Verwenden von Terraform als IaC-Anbieter
• Verwalten von Umgebungsvariablen