Справочник по схеме azure Developer CLI

Файл azure.yaml — это файл конфигурации для проектов Интерфейса командной строки разработчика Azure (azd). Поместите его в корень проекта, чтобы определить службы, ресурсы Azure, инфраструктуру, перехватчики и конвейер CI/CD, составляющие приложение. При выполнении таких команд, как azd up, azd provisionили azd deployинтерфейс командной строки считывает этот файл, чтобы понять структуру приложения и как развернуть его в Azure.

В этой статье приведен полный справочник по схеме azure.yaml. Сведения о начале работы с шаблонами см. в разделе "Общие сведения о azdшаблонах cli разработчика Azure".

Образец

Ниже приведен универсальный пример azure.yaml файла для azd шаблона. Пример реального мира см azure.yaml . в шаблоне 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

Свойства верхнего уровня

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
      dependsOn:
        - core
      hooks:
        postprovision:
          shell: sh
          run: ./scripts/post-provision.sh

Пример поставщика Terraform в качестве поставщика IaC

Чтобы использовать Terraform вместо Bicep, задайте для него provider значение terraform. Дополнительные сведения см. в статье Об использовании Terraform в качестве поставщика 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

(объект) определение служб, составляющих приложение. Каждый ключ — это имя службы, а значение — объект конфигурации службы.

Свойства службы

Типы узлов

Свойство host определяет тип ресурса Azure, используемого для реализации службы, и определяет, какие другие свойства допустимы.

ai.endpoint конфигурация

(объект, обязательный при host использовании ai.endpoint) Предоставляет дополнительную конфигурацию для развертывания веб-конечной точки ИИ Azure.

Конфигурация компонента ИИ

Конфигурация развертывания ИИ

Наследует все свойства из конфигурации компонента ИИ, а также:

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.endpointazure.ai.agent).

k8s

(объект) Параметры конфигурации службы Azure Kubernetes (AKS). Допустимо только в том hostслучаеaks.

Конфигурация развертывания

Конфигурация службы

Конфигурация входящего трафика

Конфигурация Helm

repositories Элементы массива:

releases Элементы массива:

Конфигурация Kustomize

Механизмы сервисных подключений

Перехватчики уровня обслуживания выполняются во время событий жизненного цикла службы. Перехватчики должны совпадать с именами событий службы, префиксами или prepost. При указании путей они должны быть относительно пути службы. Дополнительные сведения см. в статье Настройка рабочих процессов azure Developer CLI с помощью команд и событий.

Поддерживаемые перехватчики служб: prerestore, postrestoreprebuildpostbuildprepackagepostpackageprepublishpostpublish, . predeploypostdeploy

Каждый перехватчик использует формат определения перехватчика .

Примеры служб

Контейнерные приложения с параметрами 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

Приложения-контейнеры из предварительно созданного образа

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, postprovisionpreinfracreatepostinfracreatepreinfradeletepostinfradeletepredownpostdownpreuppostupprepackagepostpackageprepublishpostpublishpredeploypostdeployprerestorepostrestore;

Каждый перехватчик использует формат определения перехватчика .

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

Определение перехватчика

Крючок может быть одним объектом перехватчика или массивом объектов перехватчика. Каждый объект перехватчика имеет следующие свойства:

Настройка исполнителя перехватчика

Свойство config принимает различные свойства в зависимости от kind значения.

Конфигурация JavaScript и TypeScript (js, ts)

Конфигурация Python

Конфигурация .NET (dotnet)

Конфигурация оболочки (sh, pwsh)

В настоящее время исполнители оболочки не поддерживают 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

Несколько перехватчиков для одного события

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

Конфигурация хранилища BLOB-объектов Azure

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 .

Шаги рабочего процесса

Рабочий upsteps процесс принимает массив (или может быть указан непосредственно как массив). Каждый шаг выполняет azd команду.

Настройка порядка шагов рабочего процесса

azure.yaml Следующий файл изменяет поведение azd up по умолчанию для перемещения azd package шага после azd provision шага. Используйте этот подход в сценариях, где необходимо знать 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 для государственных организаций. Облако по умолчанию .AzureCloud

cloud:
  name: AzureUSGovernment

Запрос справки

Сведения о том, как отправить ошибку, запросить справку или предложить новую функцию для Интерфейса командной строки разработчика Azure, перейдите на страницу устранения неполадок и поддержки.

Дальнейшие действия

• Настройка рабочих процессов с помощью хуков команд и событий
• Общие сведения о шаблонах ИНТЕРФЕЙСА командной строки разработчика Azure
• Использование Terraform в качестве поставщика IaC
• Управление переменными среды