Azure Developer CLI schema reference

O azure.yaml ficheiro é o ficheiro de configuração para projetos Azure Developer CLI (azd). Coloque-o na raiz do seu projeto para definir os serviços, recursos Azure, infraestrutura, hooks e pipeline CI/CD que compõem a sua aplicação. Quando executas comandos como azd up, azd provision, ou azd deploy, a CLI lê este ficheiro para perceber a estrutura da tua aplicação e como a implementar no Azure.

Este artigo é uma referência completa para o esquema azure.yaml. Para começar com azd templates, consulte a visão geral dos templates de CLI para Desenvolvedores do Azure.

Amostra

Segue-se um exemplo genérico de um azure.yaml ficheiro para um azd modelo. Para um exemplo do mundo real, veja o azure.yamldo modelo ToDo NodeJs Mongo:

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

Propriedades de topo

name

(fio, necessário) O nome da candidatura. Apenas letras minúsculas, números e hífens (-) são permitidos. O nome deve começar e terminar com uma letra ou número. Duração mínima: 2 caracteres.

name: my-app

resourceGroup

(string) Nome do grupo de recursos do Azure. Quando especificado, substitui o nome do grupo de recursos usado para provisionamento de infraestrutura. Suporta substituição de variáveis de ambiente. Deve ter entre 3 e 64 caracteres.

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

metadata

(objeto) Metadados sobre o modelo de aplicação.

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

infra

(objeto) Fornece configuração adicional para o provisionamento de infraestruturas Azure.

infra.layers

(array de objetos) Define camadas de provisão para a infraestrutura Azure. Cada camada representa uma unidade independente de provisionamento.

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

Terraform como amostra de provedor IaC

Para usar Terraform em vez de Bicep, defina o provider para terraform. Para mais informações, consulte Use Terraform como fornecedor de IaC.

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

(objeto) Definição dos serviços que compõem a aplicação. Cada chave é um nome de serviço, e o valor é um objeto de configuração de serviço.

Propriedades de serviço

Tipos de hospedeiros

A host propriedade determina o tipo de recurso Azure usado para a implementação do serviço e controla quais as outras propriedades que são válidas.

ai.endpoint config

(objeto, necessário quando host é ai.endpoint) Fornece configuração adicional para a implementação de endpoints online do Azure AI.

Configuração de componentes de IA

Configuração de implementação de IA

Herda todas as propriedades da configuração dos componentes de IA, mais:

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

docker

(objeto) Configuração Docker para um serviço. Aplicável apenas a hosts que suportam containers (containerapp, aks, ai.endpoint, azure.ai.agent).

k8s

(objecto) Opções de configuração Azure Kubernetes Service (AKS). Só é válido quando host é aks.

Configuração de implementação

Configuração do serviço

Configuração Ingress

Configuração do leme

repositories Itens do Array:

releases Itens do Array:

Kustomize config

Ganchos de serviço

Os ganchos de nível de serviço executam-se durante os eventos do ciclo de vida do serviço. Os ganchos devem corresponder aos nomes dos eventos de serviço com prefixo de pre ou post. Ao especificar caminhos, estes devem ser relativos ao caminho de serviço. Consulte Personalizar seus fluxos de trabalho da CLI do Desenvolvedor do Azure usando de ganchos de comando e evento para obter mais detalhes.

Ganchos de serviço suportados: prerestore, postrestore, postbuildprebuild, prepackage, postpackage, , prepublish, postpublish, predeploy. postdeploy

Cada hook utiliza o formato de definição Hook .

Amostras de serviço

Aplicações de Container com opções 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

Aplicações Container a partir de uma imagem pré-construída

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

AKS com ganchos de nível de serviço

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

(objeto) Definição dos recursos Azure usados pela aplicação. Cada chave é um nome de recurso, e o valor é um objeto de configuração de recurso. Os recursos podem ser referenciados por serviços da uses propriedade.

Propriedades comuns dos recursos

Tipos de recursos

A type propriedade determina o tipo de recurso Azure e controla quais as propriedades adicionais disponíveis.

host.appservice propriedades

runtime objeto:

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

host.containerapp propriedades

ai.openai.model propriedades

model objeto:

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

ai.project propriedades

models Itens do Array:

sku objeto:

ai.search propriedades

db.cosmos propriedades

containers Itens do Array:

messaging.eventhubs propriedades

messaging.servicebus propriedades

storage propriedades

keyvault propriedades

Exemplo de recursos

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

(objeto) Definição de pipeline de integração contínua.

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

hooks

(objeto) Ganchos de nível de comando. Os ganchos devem corresponder azd nomes de comando prefixados com pre ou post dependendo de quando o script deve ser executado. Ao especificar caminhos, eles devem ser relativos ao caminho do projeto. Consulte Personalizar seus fluxos de trabalho da CLI do Desenvolvedor do Azure usando de ganchos de comando e evento para obter mais detalhes.

Ganchos de comando suportados: , , postinfracreate, , , predownpostinfradelete, postdown, preup, postuppostrestorepostpublish. prepackagepostdeploypredeploypostpackageprepublishprerestorepreinfradeletepreinfracreatepostprovisionpreprovision

Cada hook utiliza o formato de definição Hook .

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

Definição de anzol

Um gancho pode ser um único objeto de gancho ou um conjunto de objetos gancho. Cada objeto hook tem as seguintes propriedades:

Configuração do executor de gancho

A config propriedade aceita diferentes propriedades dependendo do valor.kind

JavaScript e TypeScript (js, ts) config

Configuração em Python

.NET (dotnet) config

Configuração de shell (sh, pwsh)

Os executores de shell atualmente não suportam config propriedades.

Amostras de anzol

Ganchos específicos de plataforma

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

Gancho Python com amabilidade

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

Múltiplos ganchos para um único evento

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

requiredVersions

(objeto) Fornece configuração adicional para as versões necessárias de azd e extensões.

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

state

(objeto) Fornece configuração adicional para gestão de estados.

state.remote

Azure Blob Storage config

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

platform

(objeto) Fornece configuração adicional para funcionalidades específicas da plataforma, como o Azure Dev Center.

Configuração do Centro de Desenvolvimento

Disponível quando type é devcenter:

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

workflows

(objeto) Fornece configuração adicional para fluxos de trabalho, como o comportamento de sobreposição azd up .

Etapas do fluxo de trabalho

O up fluxo de trabalho aceita um steps array (ou pode ser especificado diretamente como um array). Cada passo executa um azd comando.

Configurar a ordem dos passos do fluxo de trabalho

O ficheiro seguinte azure.yaml altera o comportamento padrão de azd up mover o azd package passo após o azd provision passo. Use esta abordagem em cenários onde precisa de conhecer as URLs dos recursos durante o processo de construção ou empacotamento.

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

cloud

(objeto) Fornece configuração adicional para implementação em clouds soberanas como Azure Government. A cloud padrão é AzureCloud.

cloud:
  name: AzureUSGovernment

Pedir ajuda

Para obter informações sobre como arquivar um bug, solicitar ajuda ou propor um novo recurso para a CLI do Desenvolvedor do Azure, visite a página de solução de problemas e suporte do.

Próximos passos

• Personalize fluxos de trabalho usando ganchos de comandos e eventos
• Visão geral dos templates de CLI para desenvolvedores Azure
• Use o Terraform como fornecedor IaC
• Gerir variáveis do ambiente