Поделиться через

Общие сведения о шаблонах ИНТЕРФЕЙСА командной строки разработчика Azure

  • Статья

Шаблоны ИНТЕРФЕЙСА командной строкиazd разработчика Azure — это стандартные репозитории кода, включающие пример кода приложения, а также azd файлы конфигурации и инфраструктуры. azd шаблоны позволяют подготавливать ресурсы Azure, развертывать приложение, настраивать конвейеры CI/CD и многое другое. Вы можете создать собственные шаблоны или приступить к работе с существующим шаблоном из репозитория шаблонов, например Awesome AZD. В этой статье вы узнаете о следующих понятиях:

  • Как azd шаблоны позволяют подготавливать и развертывать ресурсы приложений
  • Структура azd шаблонов
  • Как решить, следует ли использовать существующий шаблон или создать его
  • Изучение существующих azd начальных шаблонов

Почему используйте шаблоны ИНТЕРФЕЙСА командной строки разработчика Azure?

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

Например, предположим, что вы работаете в компании, которая работает с платформой управления билетами и взаимодействием с клиентами, для которой требуются следующие ресурсы Azure:

  • Два экземпляра Служба приложений и план Служба приложений для размещения интерфейсного веб-приложения и внутреннего API
  • Экземпляр Key Vault для хранения секретов безопасного приложения
  • База данных Cosmos DB для постоянного хранения данных приложения
  • Ресурсы Azure Monitor, такие как панели мониторинга Application Insights
  • Служебная шина для управления масштабируемыми сообщениями
  • Конвейеры CI/CD, обеспечивающие надежное развертывание изменений с помощью автоматизированного повторяемого процесса.

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

Как работают шаблоны интерфейса командной строки разработчика Azure

Шаблоны ИНТЕРФЕЙСА командной строки разработчика Azure предназначены для работы с azd такими командами, как azd init и azd up. Шаблоны включают файлы конфигурации и инфраструктуры как кода (IaC), используемые командами для выполнения таких задач, как подготовка ресурсов Azure и развертывание кода приложения в них.

Например, типичный рабочий процесс, использующий azd существующий шаблон, включает следующие действия:

  1. azd init Выполните команду с параметром--template, чтобы клонировать существующий шаблон вниз с GitHub.

    azd init --template todo-nodejs-mongo

  2. Выполните команду, чтобы пройти проверку подлинности в подписке azd auth login Azure.

    azd auth login

  3. azd up Выполните команду, чтобы подготовить и развернуть ресурсы шаблона в Azure. Команда azd up использует файлы конфигурации и инфраструктуры как кода (IaC) в шаблоне для подготовки ресурсов Azure и развертывания приложения в этих ресурсах.

    azd up

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

Общие сведения о структуре шаблона Интерфейса командной строки разработчика Azure

Все azd шаблоны используют аналогичную структуру файлов на azd основе соглашений. Минимальные необходимые ресурсы обычно включают следующие:

  • infra папка — содержит всю инфраструктуру Bicep или Terraform в виде файлов кода для azd шаблона. azd выполняет эти файлы, чтобы создать ресурсы Azure, необходимые для размещения приложения.

  • azure.yaml file — файл конфигурации, который определяет одну или несколько служб в проекте и сопоставляет их с ресурсами Azure, определенными в папке infra для развертывания. Например, можно определить службу API и веб-интерфейсную службу и сопоставить их с различными ресурсами Azure для развертывания.

  • .azure папка — содержит основные конфигурации Azure и переменные среды, такие как расположение для развертывания ресурсов или других сведений о подписке.

  • src папка — содержит весь исходный код развертываемого приложения. Некоторые azd шаблоны исключают папку src и предоставляют только ресурсы инфраструктуры, чтобы можно было добавить собственный код приложения.

    Примечание.

    Шаблоны, которые исключают папку src , обычно предназначены как начальные шаблоны инфраструктуры.

azd шаблоны также необязательно включают одну или несколько следующих папок:

  • .github folder — содержит файлы рабочих процессов CI/CD для GitHub Actions, поставщик CI/CD по умолчанию для azd.
  • .azdo папка . Если вы решите использовать Azure Pipelines для CI/CD, определите файлы конфигурации рабочего процесса в этой папке.
  • .devcontainer папка — позволяет настроить среду контейнера разработки для приложения.

Например, общий azd шаблон может соответствовать следующей структуре папок:

Снимок экрана: структура шаблона Azure Developer CLI.

Начните с существующего шаблона или создайте собственный

Существует два основных подхода к работе с azd шаблонами:

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

В следующих разделах приведены дополнительные сведения об этих двух вариантах.

Начните с существующего шаблона

Широкий выбор шаблонов доступен в коллекции шаблонов azd awesome-azd. Эти шаблоны предоставляют код инфраструктуры и приложения для различных сценариев разработки, языковых платформ и служб Azure. Если вы найдете шаблон, соответствующий локальному стеку приложений или требуемой архитектуре, вы можете расширить и заменить код шаблона собственным.

Например, следующие azd шаблоны предоставляют отправные точки для распространенных архитектур и платформ приложений:

Template Узел приложения Технический стек
React Web App с API C# и MongoDB в Azure Служба приложений Azure Azure Cosmos DB для NoSQL, Bicep
React Web App с API C# и База данных SQL в Azure Служба приложений Azure База данных SQL Azure, Bicep
Статические веб-приложения React + Функции с API C# и База данных SQL в Azure Статические веб-приложения Azure, Функции Azure База данных SQL Azure, Bicep

Создание шаблона azd для приложения

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

  • Инициализация шаблона проекта с azd initпомощью .
  • Создайте инфраструктуру Bicep или Terraform в виде файлов кода в папке infra .
  • azure.yaml Обновите файл, чтобы связать службы приложений вместе с ресурсами Azure.
  • Подготовка и развертывание с azd upпомощью .

Следующие ресурсы содержат дополнительные сведения о создании собственных шаблонов:

Рекомендации по использованию azd шаблонов

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

Корпорация Майкрософт не несет ответственности за любые шаблоны, отличные от Майкрософт, и не отображает эти шаблоны для обеспечения безопасности, конфиденциальности, совместимости или проблем с производительностью. Шаблоны, используемые с интерфейсом командной строки разработчика Azure, включая предоставленные корпорацией Майкрософт, не поддерживаются ни одной программой поддержки Майкрософт или службой. Любые предоставленные корпорацией Майкрософт шаблоны предоставляются КАК IS без каких-либо гарантий.

Следующие шаги

Выбор и развертывание шаблона