Cli-schemareferens för Azure Developer

Filen azure.yaml är konfigurationsfilen för Azure Developer CLI-projekt (azd). Placera den i roten för projektet för att definiera de tjänster, Azure-resurser, infrastruktur, krokar och CI/CD-pipeline som utgör ditt program. När du kör kommandon som azd up, azd provisioneller azd deploy, läser CLI den här filen för att förstå appens struktur och hur du distribuerar den till Azure.

Den här artikeln är en fullständig referens för azure.yaml-schemat. Information om hur du kommer igång med azd mallar finns i Översikt över CLI-mallar för Azure Developer.

Prov

Följande är ett allmänt exempel på en azure.yaml fil för en azd mall. Ett verkligt exempel finns i azure.yaml från Mongo-mallen ToDo NodeJs:

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

Egenskaper på den översta nivån

name

(sträng, krävs) Programnamnet. Endast gemener, siffror och bindestreck (-) tillåts. Namnet måste börja och sluta med en bokstav eller siffra. Minsta längd: 2 tecken.

name: my-app

resourceGroup

(sträng) Namnet på Azure-resursgruppen. När det anges åsidosätter det resursgruppsnamn som används för infrastrukturetablering. Stöder ersättning av miljövariabler. Måste vara mellan 3 och 64 tecken.

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

metadata

(objekt) Metadata om programmallen.

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

infra

(objekt) Tillhandahåller ytterligare konfiguration för etablering av Azure-infrastruktur.

infra.layers

(matris med objekt) Definierar etableringslager för Azure-infrastruktur. Varje lager representerar en oberoende etableringsenhet.

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

Exempel på Terraform som IaC-provider

Om du vill använda Terraform i stället för Bicep anger du provider till terraform. Mer information finns i Använda Terraform som IaC-provider.

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 av tjänster som ingår i programmet. Varje nyckel är ett tjänstnamn och värdet är ett tjänstkonfigurationsobjekt.

Tjänstegenskaper

Värdtyper

Egenskapen host avgör vilken typ av Azure-resurs som används för tjänstimplementering och kontrollerar vilka andra egenskaper som är giltiga.

ai.endpoint Config

(objekt, krävs när host är ai.endpoint) Tillhandahåller ytterligare konfiguration för azure AI-onlineslutpunktsdistribution.

AI-komponentkonfiguration

Konfiguration av AI-distribution

Ärver alla egenskaper från AI-komponentkonfigurationen, 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 en tjänst. Gäller endast för värdar som stöder containrar (containerapp, aks, ai.endpoint, azure.ai.agent).

k8s

(objekt) Konfigurationsalternativ för Azure Kubernetes Service (AKS). Endast giltigt när host är aks.

Distributionskonfiguration

Tjänstkonfiguration

Ingresskonfiguration

Helm-konfiguration

repositories matrisobjekt:

releases matrisobjekt:

Kustomize-konfiguration

Servicekopplingar

Hookar på tjänstnivå körs under händelser i tjänstens livscykel. Hooks ska matcha tjänsthändelsenamn som är prefixet med pre eller post. När du anger sökvägar bör de vara relativa till tjänstsökvägen. Mer information finns i Anpassa cli-arbetsflöden för Azure Developer med hjälp av kommando- och händelsekrokar.

Tjänstkrokar som stöds: prerestore, postrestore, prebuild, postbuild, prepackage, postpackage, prepublish, postpublish, predeploy, postdeploy.

Varje krok använder hookdefinitionsformatet .

Tjänstexempel

Alternativ för Container Apps med 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 från en fördefinierad avbildning

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

AKS med krokar på servicenivå

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 av Azure-resurser som används av programmet. Varje nyckel är ett resursnamn och värdet är ett resurskonfigurationsobjekt. Resurser kan refereras av tjänster via egenskapen uses .

Vanliga resursegenskaper

Resurstyper

Egenskapen type avgör vilken typ av Azure-resurs och styr vilka ytterligare egenskaper som är tillgängliga.

host.appservice egenskaper

runtime Objekt:

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

host.containerapp egenskaper

ai.openai.model egenskaper

model Objekt:

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

ai.project egenskaper

models matrisobjekt:

sku Objekt:

ai.search egenskaper

db.cosmos egenskaper

containers matrisobjekt:

messaging.eventhubs egenskaper

messaging.servicebus egenskaper

storage egenskaper

keyvault egenskaper

Exempel på resurser

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 av pipeline för kontinuerlig integrering.

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

hooks

(objekt) Kommandonivåkrokar. Hooks bör matcha azd kommandonamn som är prefix med pre eller post beroende på när skriptet ska köras. När du anger sökvägar bör de vara relativa till projektsökvägen. Mer information finns i Anpassa cli-arbetsflöden för Azure Developer med hjälp av kommando- och händelsekrokar.

Kommandokrokar som stöds: preprovision, postprovision, preinfracreate, postinfracreate, preinfradelete, postinfradelete, predown, postdown, preup, postup, prepackage, , postpackage, prepublish, postpublish, predeploy, postdeploy, prerestore. postrestore

Varje krok använder hookdefinitionsformatet .

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

Hook-definition

En krok kan vara ett enda krokobjekt eller en matris med krokobjekt. Varje hook-objekt har följande egenskaper:

Konfiguration av hook executor

Egenskapen config accepterar olika egenskaper beroende på värdet kind .

JavaScript- och TypeScript-konfiguration (js, ts)

Python-konfiguration

.NET-konfiguration (dotnet)

Shell (sh, pwsh) config

Shell-utförare stöder config för närvarande inte egenskaper.

Krokexempel

Plattformsspecifika krokar

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

Python-krok med typ

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

Flera krokar för en enskild händelse

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

requiredVersions

(objekt) Tillhandahåller ytterligare konfiguration för nödvändiga versioner av azd och tillägg.

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

state

(objekt) Tillhandahåller ytterligare konfiguration för tillståndshantering.

state.remote

Azure Blob Storage-konfiguration

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

platform

(objekt) Ger ytterligare konfiguration för plattformsspecifika funktioner som Azure Dev Center.

Dev Center-konfiguration

Tillgängligt när type är devcenter:

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

workflows

(objekt) Tillhandahåller ytterligare konfiguration för arbetsflöden, till exempel åsidosättande azd up beteende.

Arbetsflödessteg

Arbetsflödet up accepterar en steps matris (eller kan anges direkt som en matris). Varje steg kör ett azd kommando.

Konfigurera arbetsflödets stegordning

azure.yaml Följande fil ändrar standardbeteendet azd up för att flytta azd package steget efter stegetazd provision. Använd den här metoden i scenarier där du behöver känna till URL:er för resurser under bygg- eller paketeringsprocessen.

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) Tillhandahåller ytterligare konfiguration för distribution till nationella moln, till exempel Azure Government. Standardmolnet är AzureCloud.

cloud:
  name: AzureUSGovernment

Begär hjälp

Information om hur du skickar in en bugg, begär hjälp eller föreslår en ny funktion för Azure Developer CLI finns på sidan felsökning och support.

Nästa steg

• Anpassa arbetsflöden med hjälp av kommando- och händelsekrokar
• Översikt över CLI-mallar för Azure Developer
• Använda Terraform som IaC-provider
• Hantera miljövariabler