Naslaginformatie over Azure Developer CLI-schema

Het azure.yaml bestand is het configuratiebestand voor Azure Developer CLI-projecten (azd). Plaats deze in de hoofdmap van uw project om de services, Azure-resources, infrastructuur, hooks en CI/CD-pijplijn te definiëren waaruit uw toepassing bestaat. Wanneer u opdrachten uitvoert zoals azd up, azd provisionof azd deploy, leest de CLI dit bestand om inzicht te hebben in de structuur van uw app en hoe u het in Azure implementeert.

Dit artikel is een volledig overzicht van het azure.yaml-schema. Zie het overzicht van Azure Developer CLI-sjablonen om aan de slag te gaan met azd sjablonen.

Monster

Hier volgt een algemeen voorbeeld van een azure.yaml bestand voor een azd sjabloon. Zie de azure.yamlsjabloon ToDo NodeJs Mongo voor een praktijkvoorbeeld:

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

Eigenschappen op het hoogste niveau

name

(tekenreeks, vereist) De naam van de toepassing. Alleen kleine letters, cijfers en afbreekstreepjes (-) zijn toegestaan. De naam moet beginnen en eindigen met een letter of cijfer. Minimale lengte: 2 tekens.

name: my-app

resourceGroup

(tekenreeks) naam van de Azure-resourcegroep. Wanneer u dit hebt opgegeven, wordt de naam van de resourcegroep overschreven die wordt gebruikt voor het inrichten van de infrastructuur. Ondersteunt vervanging van omgevingsvariabelen. Moet tussen 3 en 64 tekens zijn.

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

metadata

(object) Metagegevens over de toepassingssjabloon.

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

infra

(object) Biedt aanvullende configuratie voor het inrichten van azure-infrastructuur.

infra.layers

(matrix met objecten) Definieert inrichtingslagen voor Azure-infrastructuur. Elke laag vertegenwoordigt een onafhankelijke inrichtingseenheid.

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

Voorbeeld van Terraform als IaC-provider

Als u Terraform in plaats van Bicep wilt gebruiken, stelt u het in provider op terraform. Zie Terraform gebruiken als een IaC-provider voor meer informatie.

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

(object) Definitie van services waaruit de toepassing bestaat. Elke sleutel is een servicenaam en de waarde is een serviceconfiguratieobject.

Service-eigenschappen

Hosttypen

De host eigenschap bepaalt het type Azure-resource dat wordt gebruikt voor service-implementatie en bepaalt welke andere eigenschappen geldig zijn.

ai.endpoint Config

(object, vereist wanneer host ) ai.endpoint Biedt aanvullende configuratie voor de implementatie van azure AI online-eindpunten.

Configuratie van AI-onderdelen

Configuratie van AI-implementatie

Neemt alle eigenschappen over van de configuratie van ai-onderdelen, plus:

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

docker

(object) Docker-configuratie voor een service. Alleen van toepassing op hosts die containers ondersteunen (containerapp, aks, ai.endpoint). azure.ai.agent

k8s

(object) Configuratieopties voor Azure Kubernetes Service (AKS). Alleen geldig wanneer host .aks

Implementatieconfiguratie

Serviceconfiguratie

Configuratie voor inkomend verkeer

Helm-configuratie

repositories matrixitems:

releases matrixitems:

Kustomize-configuratie

Service-invoerpunten

Service level hooks worden uitgevoerd tijdens gebeurtenissen voor de levenscyclus van de service. Hooks moeten overeenkomen met namen van servicegebeurtenissen die zijn voorafgegaan door pre of post. Wanneer u paden opgeeft, moeten ze relatief zijn ten opzichte van het servicepad. Zie Uw Azure Developer CLI-werkstromen aanpassen met behulp van opdracht- en gebeurtenishook voor meer informatie.

Ondersteunde servicehook: prerestore, postrestore, prebuild, postbuild, prepackage, postpackage, , prepublish, postpublish. postdeploypredeploy

Elke hook maakt gebruik van de definitie-indeling Hook .

Servicevoorbeelden

Container Apps met Docker-opties

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 van een vooraf gemaakte installatiekopieën

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

AKS met serviceniveauhook

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

(object) Definitie van Azure-resources die door de toepassing worden gebruikt. Elke sleutel is een resourcenaam en de waarde is een resourceconfiguratieobject. Er kan naar resources worden verwezen door services via de uses eigenschap.

Algemene resource-eigenschappen

Resourcetypen

De type eigenschap bepaalt het type Azure-resource en bepaalt welke aanvullende eigenschappen beschikbaar zijn.

host.appservice eigenschappen

runtime Object:

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

host.containerapp eigenschappen

ai.openai.model eigenschappen

model Object:

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

ai.project eigenschappen

models matrixitems:

sku Object:

ai.search eigenschappen

db.cosmos eigenschappen

containers matrixitems:

messaging.eventhubs eigenschappen

messaging.servicebus eigenschappen

storage eigenschappen

keyvault eigenschappen

Voorbeeld van resources

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

(object) definitie van pijplijn voor continue integratie.

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

hooks

(object) Haken op opdrachtniveau. Hooks moeten overeenkomen met azd opdrachtnamen die zijn voorafgegaan door pre of post, afhankelijk van wanneer het script moet worden uitgevoerd. Wanneer u paden opgeeft, moeten ze relatief zijn ten opzichte van het projectpad. Zie Uw Azure Developer CLI-werkstromen aanpassen met behulp van opdracht- en gebeurtenishook voor meer informatie.

Ondersteunde opdrachthaken: , , , , postinfracreatepreinfradelete, predownpostinfradelete, , postupprepublishpredeploypostdownpreupprepackagepostdeploypostpackagepostpublish, . prerestorepostrestorepreinfracreatepostprovisionpreprovision

Elke hook maakt gebruik van de definitie-indeling Hook .

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

Hook-definitie

Een haak kan één haakobject of een matrix van haakobjecten zijn. Elk haakobject heeft de volgende eigenschappen:

Hook executor-configuratie

De config eigenschap accepteert verschillende eigenschappen, afhankelijk van de kind waarde.

JavaScript- en TypeScript-configuratie (js, ts)

Python-configuratie

Configuratie van .NET (dotnet)

Shell-configuratie (sh, pwsh)

Shell-uitvoerders ondersteunen config momenteel geen eigenschappen.

Hook-voorbeelden

Platformspecifieke hooks

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

Python-hook met soort

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

Meerdere hooks voor één gebeurtenis

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

requiredVersions

(object) Biedt aanvullende configuratie voor vereiste versies en azd extensies.

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

state

(object) Biedt aanvullende configuratie voor statusbeheer.

state.remote

Azure Blob Storage-configuratie

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

platform

(object) Biedt aanvullende configuratie voor platformspecifieke functies, zoals Azure Dev Center.

Configuratie van Dev Center

Beschikbaar wanneertype:devcenter

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

workflows

(object) Biedt aanvullende configuratie voor werkstromen, zoals het negeren van azd up gedrag.

Werkstroomstappen

De up werkstroom accepteert een steps matrix (of kan rechtstreeks als een matrix worden opgegeven). Elke stap voert een azd opdracht uit.

Volgorde van werkstroomstap configureren

In het volgende azure.yaml bestand wordt het standaardgedrag gewijzigd om azd up de azd package stap na de azd provision stap te verplaatsen. Gebruik deze methode in scenario's waarin u de URL's van resources tijdens het bouw- of verpakkingsproces moet kennen.

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

cloud

(object) Biedt aanvullende configuratie voor implementatie in onafhankelijke clouds, zoals Azure Government. De standaardcloud is AzureCloud.

cloud:
  name: AzureUSGovernment

Hulp vragen

Ga naar de pagina voor probleemoplossing en ondersteuning voor informatie over het indienen van een bug, hulp vragen of een nieuwe functie voorstellen voor de Azure Developer CLI.

Volgende stappen

• Werkstromen aanpassen met behulp van opdracht- en gebeurtenishook
• Overzicht van Azure Developer CLI-sjablonen
• Terraform gebruiken als een IaC-provider
• Omgevingsvariabelen beheren