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

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

Общие сведения о источниках шаблонов

Источник шаблона azd указывает на файл конфигурации JSON, описывающий список доступных шаблонов и их основные метаданные, такие как имя, описание и расположение исходного кода шаблона (обычно репозиторий GitHub). При включении источника шаблона определяемые шаблоны становятся доступными для azd других команд. Например, приведенный ниже фрагмент кода JSON источника шаблона определяет два шаблона:

[
  {
    "name": "Starter - Bicep",
    "description": "A starter template with Bicep as infrastructure provider",
    "repositoryPath": "azd-starter-bicep",
    "tags": ["bicep"]
  },
  {
    "name": "Starter - Terraform",
    "description": "A starter template with Terraform as infrastructure provider",
    "repositoryPath": "azd-starter-terraform",
    "tags": ["terraform"]
  }
]

Каждая запись шаблона в файле конфигурации JSON содержит следующие свойства:

  • имя: отображаемое имя шаблона.
  • описание: краткое описание того, что делает шаблон.
  • репозиторий: путь к исходному коду шаблона, который может быть таким:
    • Полный URI для Git-репозитория, например "https://dev.azure.com/org/project/_git/repo"".
    • "{owner}/{repo}" для репозиториев GitHub.
    • "{repo}" для репозиториев GitHub в организации Azure-Samples.
  • теги: ключевые слова, которые помогают пользователям с помощью azd init --filter <tag> и azd template list --filter <tag>фильтровать шаблоны.

Полный пример см. в этом файле JSON, который является источником шаблона по умолчанию, включенным в azd.

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

  • awesome-azd — список шаблонов из коллекции Awesome AZD, которая включена по умолчанию.
  • по умолчанию — небольшой набор курируемых шаблонов для демонстрации различных технологических стеков.
  • file — локальный или сетевой путь, указывающий на файл конфигурации источника шаблона JSON.
  • URL-адрес — адресируемый путь HTTP(S), указывающий на исходный файл конфигурации JSON шаблона.
  • gh . Указывает на репозиторий GitHub.
  • ade — указывает на список шаблонов среды развертывания Azure. Дополнительные сведения о поддержке Интерфейса командной строки разработчика Azure для сред развертывания Azure.

Работа с источниками шаблонов

azd предоставляет несколько команд для настройки источников шаблонов.

azd template source list Используйте команду для перечисления всех настроенных в настоящее время источников шаблонов:

azd template source list

Пример выходных данных с двумя настроенными источниками шаблонов:

Key          Name         Type         Location

awesome-azd  Awesome AZD  awesome-azd  https://aka.ms/awesome-azd/templates.json
default      Default      resource

azd template source add Используйте команду, чтобы добавить новый источник шаблона. Эта команда принимает следующие параметры:

  • ключ: техническое имя источника шаблона.
  • --type, -t: тип источника шаблона — допустимые значения: файл, URL-адрес и gh для GitHub.
  • --location, -l: расположение источника шаблона, которое должно быть локальной сетью или веб-URI HTTP(S).
  • --name, -n: Отображаемое имя источника шаблона (необязательно; если опущено, используется ключ ).
azd template source add <key> --type <file-or-url-or-gh> --location <your-uri> --name <your-display-name>

azd template source remove Используйте команду для удаления источника шаблона:

azd template source remove <key>

azd config reset Используйте команду для сброса конфигурации шаблона обратно в параметры по умолчанию:

azd config reset

Работа со списками шаблонов

После настройки источников шаблонов используйте azd template list команду для перечисления доступных шаблонов из этих источников:

azd template list

Например, установка azd по умолчанию содержит следующие шаблоны из источника шаблона awesome-azd :

Name                                                         Source       Repository Path

Event Driven Java Application with Azure Service Bus         Awesome AZD  Azure-Samples/ASA-Samples-Event-Driven-Application
Static React Web App with Java API and PostgreSQL            Awesome AZD  Azure-Samples/ASA-Samples-Web-Application
SAP CAP on Azure App Service Quickstart                      Awesome AZD  Azure-Samples/app-service-javascript-sap-cap-quickstart
SAP Cloud SDK on Azure App Service Quickstart (TypeScript)   Awesome AZD  Azure-Samples/app-service-javascript-sap-cloud-sdk-quickstart
Java Spring Apps with Azure OpenAI                           Awesome AZD  Azure-Samples/app-templates-java-openai-springapps
WordPress with Azure Container Apps                          Awesome AZD  Azure-Samples/apptemplate-wordpress-on-ACA
Bicep template to bootstrap Azure Deployment Environments    Awesome AZD  Azure-Samples/azd-deployment-environments
Starter - Bicep                                              Awesome AZD  Azure-Samples/azd-starter-bicep
Starter - Terraform                                          Awesome AZD  Azure-Samples/azd-starter-terraform
...
# Additional templates omitted

--source Добавьте флаг только в шаблоны списков из определенного источника:

azd template list --source <source-name>

Чтобы инициализировать шаблон из отображаемого списка, выполните команду azd init и укажите путь к репозиторию шаблона:

azd init --template <path-value>

Работа с средами развертывания Azure

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

Интеграция ADE выходит за рамки этой статьи. Дополнительные сведения о настройке поддержки ade в поддержке Azure Developer CLI для документации по средам развертывания Azure.

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

Поддержка интерфейса командной строки разработчика Azure для ссылки на список шаблонов средразвертывания Azure

  • Last updated on