配置和使用模板源

Azure 开发人员 CLI 围绕一个功能强大的模板系统设计,可以简化 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 配置文件中的每个模板条目包含以下属性:

  • 名称:模板的显示名称。
  • 说明:模板执行的操作的简要摘要。
  • repositoryPath:模板源代码的路径,可以是:
    • Git 存储库的完全限定 URI,例如“https://dev.azure.com/org/project/_git/repo"”。
    • GitHub存储库的“{owner}/{repo}”。
    • Azure-Samples 组织下GitHub存储库的“{repo}”。
  • 标记:帮助用户筛选模板的 azd init --filter <tag> 关键字和 azd template list --filter <tag>

有关完整示例,请参阅 此 JSON 文件,该文件是包含在 azd其中的默认模板源。

azd 允许一次启用多个模板源。 当前有以下模板源选项可供选择:

  • awesome-azd - 默认情况下已启用的 真棒 AZD 库中 的标准模板列表。 标准模板有空或缺席 templateType
  • default - 一小组特选模板,用于演示不同的技术堆栈。
  • file - 指向模板源 JSON 配置文件的本地/网络路径。
  • url - 指向模板源 JSON 配置文件的 HTTP(S) 可寻址路径。
  • gh - 指向 GitHub 存储库。
  • ade - 指向 Azure 部署环境模板列表。 详细了解 Azure 部署环境的 Azure 开发人员 CLI 支持。

使用模板源

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:模板源类型 - 有效值为 文件URLGitHub 的 gh
  • --location,-l:模板源位置,应为本地网络或 HTTP(S) Web URI。
  • --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 template list 命令仅包含空或不存在 templateType的标准模板。 它不包括特定于扩展的模板,例如设置为 templateTypeextension.ai.agent.. 若要初始化特定于扩展的模板,请按照扩展或模板文档进行操作。

例如,默认安装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 开发人员 CLI (azd) 还提供对 Azure 部署环境的支持。 Azure 部署环境(ADE)是预定义订阅中部署的 Azure 资源的预配置集合。 Azure 治理根据环境类型(如沙箱、测试、暂存或生产)应用于这些订阅。 使用 Azure 部署环境,可以强制实施企业安全策略,并提供一组精选的预定义基础结构即代码(IaC)模板。

ADE 集成超出了本文的范围。 了解有关在 ade支持文档中配置支持的详细信息。

后续步骤