обзор разработки шаблонов Azure Developer CLI (azd)

Шаблоны Azure Developer CLI (azd) включают в себя конфигурацию, инфраструктуру и при необходимости код приложения, необходимые для подготовки и развертывания решения в Azure. Вы можете использовать шаблон для приложения, проекта, включающего только инфраструктуру, или в качестве повторно используемой основы для будущих проектов.

Note

Прежде чем приступить к работе, ознакомьтесь с шаблонами cli разработчика Azure для полного описания структуры шаблона, обязательных и необязательных ресурсов, связей между службами и azd способами использования каждого файла.

Рабочий процесс разработки шаблонов

Следующий рабочий процесс применяется к созданию шаблона или инициализации уже существующего:

Схема рабочего процесса разработки шаблона azd, от выбора отправной точки до запуска azd up и обслуживания шаблона.

Схема рабочего процесса разработки шаблонов cli для разработчиков Azure. Слева поле с надписью "Выбор начальной точки" содержит два варианта: "Начать с нового шаблона" и "Начать с существующего шаблона". Оба варианта ведут к «Просмотрите и измените файлы шаблона». Оттуда дополнительная ветка ведет к шагу "Расширить шаблон", а основная ветка — к шагу "Выполнить azd up". Шаг «Расширить шаблон» также ведёт к шагу «Выполните команду azd up.» Наконец, выполнение команды "azd up" ведёт далее к разделу "Поддержка шаблона или общий доступ к нему".

  • Выберите отправную точку:Начнитес нового шаблона с помощью интеграции GitHub Copilot, другого помощника по написанию кода ИИ или прямого разработки. Кроме того, начните с существующего шаблона из Microsoft, вашей организации или сообщества разработчиков.
  • Изучите и измените файлы: Посмотрите, как azure.yamlфайлы Bicep или Terraform, код приложения и вспомогательная конфигурация работают вместе. Ознакомьтесь с разделом "Просмотр и изменение файлов шаблонов".
  • Расширение и развитие по мере необходимости: Добавление, замена, удаление или изменение компонентов приложения и инфраструктуры. Следуйте инструкциям по расширению шаблона для комплексного примера, который добавляет ресурс Azure и подключает его к приложению.
  • Подготовка и развертывание: Запустите azd up , чтобы подготовить инфраструктуру и развернуть все службы приложений. Дополнительные сведения см. в azd up разделе "Изучение рабочего процесса".
  • Обслуживание или предоставление общего доступа: Продолжайте редактирование шаблона по мере развития проекта. Если вы планируете предоставить общий доступ к нему, сначала протестируйте его в чистом каталоге и с помощью новой azd среды.

Note

В рамках этого рабочего процесса вы можете создавать, изменять или заменять файлы шаблонов самостоятельно или с помощью помощника по написанию кода ИИ. Результатом является тот же набор стандартных редактируемых azd ресурсов.

Стандартные блоки шаблона

Каждый шаблон поддерживает другое решение, но большинство azd шаблонов объединяют одни и те же типы ресурсов:

  • Конфигурация проекта: Файл azure.yaml определяет проект, развертываемые службы, исходные каталоги, цели хостинга и необязательные хуки или рабочие процессы.
  • Инфраструктура как код: Bicep или Terraform-файлы определяют необходимые Azure ресурсы, назначения ролей, сети и параметры приложений.
  • Источник приложения: Шаблон может включать одно или несколько развертываемых приложений или содержать только инфраструктуру.
  • Конфигурация среды: Параметры передают в процесс развертывания значения, специфичные для среды, а выходные значения инфраструктуры становятся значениями в активной среде azd.

Шаблон для приложения может использовать следующую структуру папок:

.
├── azure.yaml                # Project configuration
├── infra/                    # Infrastructure as code
│   ├── main.bicep
│   ├── main.parameters.json
│   └── modules/
├── src/                      # Application source
│   ├── api/
│   └── web/
├── .github/                  # Pipeline workflows
│   └── workflows/
└── README.md

Точная структура зависит от проекта. Исходный код приложения, модули инфраструктуры и файлы конвейера являются необязательными, а azure.yaml определяет пути, которые использует azd. Эти ресурсы работают вместе на протяжении всего жизненного цикла разработки шаблонов.

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

Запрос помощи

Чтобы получить информацию о том, как сообщить об ошибке, запросить помощь или предложить новую функцию для интерфейса командной строки разработчика Azure (CLI), перейдите на страницу устранения неполадок и поддержки.