快速入门：部署Azure开发人员 CLI 模板

在本快速入门指南中，你将了解如何使用 Azure 开发者 CLI（azd）模板 实现 Azure 应用资源的预配和部署，只需要几个 azd 命令。 azd 模板是包含应用程序源代码的标准代码存储库，以及用于预配Azure资源的 azd 配置和基础结构文件。 若要详细了解 azd 模板以及如何加速 Azure 预配和部署过程，请参阅 什么是 Azure 开发者 CLI 模板？。

选择并部署模板

对于后续步骤，你将使用以下模板在Azure上预配和部署应用：

在 Azure 上使用 Node.js API 和 MongoDB 的 React Web 应用

使用 Python API 和 MongoDB 在 Azure 上的 React Web 应用

在 Azure 上部署使用 C# API 和 MongoDB 的 React Web 应用

在 Azure 上运行的使用 Java API 和 MongoDB 的容器化 React Web 应用

还可以从 Awesome AZD 模板库网站中选择一个符合你偏好的模板。 无论使用哪种模板，你最终都会在开发环境中使用模板代码，并能够运行命令来生成、重新部署和监视Azure中的应用。

选择首选环境以继续：

本地安装

对于传统的开发工作流程来说，本地开发环境是一个不错的选择。 你将把模板仓库克隆到你的设备中，并在本地安装的 azd 上运行命令。

先决条件

• 安装 Azure 开发人员 CLI。
• 具有活动订阅的Azure帐户。 免费创建一个。
• 包含 npm 的 Node.js (v 16.13.1 LTS)
• 查看架构图以及将在 Node.js 模板的 README 文件中部署的 Azure 资源。

• 安装 Azure 开发人员 CLI。
• 具有活动订阅的Azure帐户。 免费创建一个。
• Python 3.8
• 包含 npm 的 Node.js (v 16.13.1 LTS)
• 查看架构图以及将在 Node.js 模板的 README 文件中部署的 Azure 资源。

• 安装 Azure 开发人员 CLI。
• 具有活动订阅的Azure帐户。 免费创建一个。
• .NET 6.0
• 查看架构图以及将在 Node.js 模板的 README 文件中部署的 Azure 资源。

• 安装 Azure 开发人员 CLI。
• 具有活动订阅的Azure帐户。 免费创建一个。
• OpenJDK 17
• Docker。
• 查看架构图以及Java模板README文件中将要部署的Azure资源。

初始化项目

1. 在文件资源管理器或终端中，创建新的空目录，并将其更改为该目录。

2. 运行 azd init 命令并指定要用作参数的模板：

   azd init --template todo-nodejs-mongo
   

   azd init --template todo-python-mongo
   

   azd init --template todo-csharp-cosmos-sql
   

   azd init --template todo-java-mongo-aca
   

   出现提示时输入环境名称，例如 azdquickstart，该名称将设置为将要创建的资源组的命名前缀，用于容纳 Azure 资源。 azd 中的环境名称是什么？

   指定环境后，azd 将模板项目克隆到计算机并初始化项目。

预配和部署应用资源

1. 运行 azd auth login 命令和 azd，启动浏览器以完成登录过程。

   azd auth login
   

2. 运行 azd up 命令：

   azd up
   

3. 登录到Azure后，系统会提示输入以下信息：

   参数	说明
   Azure Location	您的资源将部署的 Azure 位置。
   Azure Subscription	要在其中部署资源的 Azure 订阅。

   选择所需的值，然后按 Enter。 azd up 命令使用模板配置和基础结构文件处理以下任务：

   • 创建和配置所有必要的Azure资源（azd provision），包括：
   • 帐户的访问策略和角色
   • 使用托管标识的服务到服务通信
   • 打包并部署代码 (azd deploy)

   azd up 命令成功完成后，CLI 会显示两个链接以查看创建的资源：

   • ToDo API 应用
   • ToDo Web 应用前端

   

   注意事项

   可以调用 azd up 任意次数来预配和部署应用程序的更新。 由于资源在所选区域中不可部署，部署可能会失败。 由于这是一个快速入门，因此删除 .azure 目录并再次尝试 azd up 是安全的。 当系统询问时，请选择其他区域。 在更高级的情况下，可以选择性地编辑 .azure 目录中的文件以更改区域。

Visual Studio Code

Azure 开发人员 CLI 提供了一个 Visual Studio Code 扩展程序，用于简化使用 azd 功能。 例如，可以使用命令面板接口来运行 azd 命令。 需要安装用于Visual Studio Code的 Azure 开发人员 CLI 扩展才能完成后续步骤。

安装Azure开发人员 CLI 扩展

1. 打开Visual Studio Code。

2. 在 “视图 ”菜单中，选择“ 扩展”。

3. 在搜索字段中，输入 Azure Developer CLI。

   

4. 选择 “安装 ”并等待安装过程完成。

初始化新应用

1. 在 Visual Studio Code 中打开一个空目录。

2. 在 “视图 ”菜单中，选择 “命令面板...”。

3. 搜索 Azure Developer CLI (azd): Initialize app (init) 命令，然后按 Enter。 该 azd up 命令指示 azd 预配和部署应用资源。

   

4. 选择 选择模板 工作流。

   

5. 在 Azure 上搜索 React Web App with Node.js API and MongoDB 模板，然后按 Enter 键选中它。

   Visual Studio Code 克隆 azd 模板。 该模板包括位于 infra 文件夹中的基础架构即代码文件和位于 src 文件夹中的示例应用程序。 基础架构即代码文件在部署应用时，会在Azure上预配所需的资源。

5. 在 Azure 上搜索 React Web App with Python API and MongoDB 模板，然后按 Enter 键选择它。

   Visual Studio Code克隆并下载azd模板。 该模板包括位于 infra 文件夹中的基础架构即代码文件和位于 src 文件夹中的示例应用程序。 基础设施即代码文件在应用部署时在Azure上配置应用所需的资源。

5. 在 Azure 上搜索 包含 C# API 和 MongoDB 的 React Web 应用模板，然后按 Enter 以选择它。

   Visual Studio Code 克隆 azd 模板。 该模板包括位于 infra 文件夹中的基础架构即代码文件和位于 src 文件夹中的示例应用程序。 代码即基础设施的文件在应用部署时，会在Azure上预配所需的资源。

5. 在 Azure 上搜索模板 包含 Java API 和 MongoDB 的容器化 React Web 应用，然后按 Enter 键以选择它。awesome-azd。

   Visual Studio Code 克隆 azd 模板。 该模板包括位于 infra 文件夹中的基础架构即代码文件和位于 src 文件夹中的示例应用程序。 应用在部署时，“基础设施即代码”文件会在Azure上配置应用所需的资源。

6. 克隆模板后，Visual Studio Code打开终端，提示你输入环境名称。 输入你选择的短名称，例如 azdvscode ，然后按 Enter。

   Enter a new environment name: [? for help] azdvscode
   

   环境名称会影响Azure中预配的资源的命名，并在 .azure 模板目录中创建一个文件夹来存储某些环境设置。

预配和部署应用资源

1. 打开命令面板并搜索 Azure Developer CLI (azd): Package, Provision and Deploy(up) 命令，然后按 Enter。 该 azd up 命令指示 azd 预配和部署应用资源。

   Visual Studio Code打开终端窗口以显示预配和部署过程的进度。 azd 使用在部署资源的过程中 init 选择的订阅和位置设置。

   注意事项

   预配和部署过程可能需要几分钟时间。

2. 部署过程完成后，选择通过浏览器启动站点时 azd 提供的输出窗口中的链接。

Codespaces

对于喜欢在容器化云环境中工作并避免在本地安装工具或依赖项的开发人员来说，Codespaces 是一个很好的选择。

创建您的 Codespace

1. 在您的浏览器中，导航到包含 Node.js API 和 MongoDB 的 React Web App on Azure 模板（或从 Awesome AZD 中选择一个）

1. 在浏览器中，在 Azure 模板上导航到具有 Python API 和 MongoDB 的 React Web 应用（或从 Awesome AZD）

1. 在浏览器中，导航到 使用 C# API 和 MongoDB 的 React Web 应用程序模板在 Azure 上（或者从 Awesome AZD 中选择一个）

1. 在您的浏览器中，导航到 具有 Java API 和 MongoDB 的容器化 React Web 应用程序模板（或从 Awesome AZD 中选择一个）

2. 在文件列表上方，单击使用此模板>在 Codespace 中打开。

使用 Codespaces 时，会为你安装所有先决条件，包括 azd Visual Studio Code 扩展。

运行模板

1. 创建 Codespace 后，右键单击根目录中的 azure.yaml。 在选项中，选择up（将资源预配并部署到 Azure）。

   

2. 运行 azd up 此命令时，系统会提示你提供以下信息，并使用 Web 浏览器和身份验证代码登录：

   

   参数	说明
   Environment Name	将用于保存所有 Azure 资源的资源组的前缀。 azd 中的环境名称是什么？ 始终可以使用 azd env new 创建新环境。
   Azure Location	您的资源将部署的 Azure 位置。
   Azure Subscription	要在其中部署资源的 Azure 订阅。

   此过程可能需要一些时间才能完成，因为 azd up 命令处理以下任务：

   • 创建和配置所有必要的Azure资源（azd provision）。
   • 为帐户配置访问策略和角色。
   • 使用托管身份实现服务到服务的通信。
   • 打包并部署代码 (azd deploy)。

   提供所需的参数和 azd up 命令完成后，CodeSpaces 终端会显示两个Azure门户链接以查看创建的资源：

   • ToDo API 应用
   • ToDo Web 应用前端

   

发生了什么情况？

成功完成 azd up 命令后：

• 模板的 文件中引用的 Azure 资源已预配到运行 后您指定的 Azure 订阅。 现在可以通过 Azure 门户查看这些Azure资源。
• 应用已生成并部署到Azure。 使用 azd up 命令中的 Web 应用 URL 输出，可以浏览到功能齐全的应用。

注意事项

• 可以调用 azd up 任意次数来预配和部署应用程序。
• 由于 GitHub Codespaces 的已知限制，目前不支持需要启动 Web 浏览器的运行和调试。 为了获得更好的体验，我们建议在桌面中使用 Codespaces。

DevContainer

DevContainer 是一个 Docker 映像，其中包含在本地计算机上使用 azd 模板所需的所有先决条件。 对于那些偏好在本地设备上运行容器化环境而不是云服务（如 GitHub Codespaces）的开发人员来说，这是一个绝佳的选择。

先决条件

• 安装 Azure 开发人员 CLI。
• 具有活动订阅的Azure帐户。 免费创建一个。
• 查看架构图以及将在 Node.js 模板 README 中部署的 Azure 资源。

• 安装 Azure 开发人员 CLI。
• 具有活动订阅的Azure帐户。 免费创建一个。
• 查看架构图及您将在 Node.js 模板自述文件中部署的 Azure 资源。

• 安装 Azure 开发人员 CLI。
• 具有活动订阅的Azure帐户。 免费创建一个。
• 查看架构图以及将在 Node.js 模板的 README 文件中部署的 Azure 资源。

• 安装 Azure 开发人员 CLI。
• 具有活动订阅的Azure帐户。 免费创建一个。
• 查看架构图以及Java模板README文件中将要部署的Azure资源。

初始化项目

1. 打开一个终端，创建一个新的空目录，然后切换到其中。

2. 运行以下命令来初始化项目：

   azd init --template todo-nodejs-mongo
   

   azd init --template todo-python-mongo
   

   azd init --template todo-csharp-cosmos-sql
   

   azd init --template todo-java-mongo-aca
   

   运行 azd init 命令时，系统会提示你提供以下信息：

   参数	说明
   Environment Name	将用于保存所有 Azure 资源的资源组的前缀。 azd 中的环境名称是什么？ 始终可以使用 azd env new 创建新环境。

打开 DevContainer

1. 在 VS Code 中打开项目。
2. 按 F1 并选择：Remote-Containers: Rebuild and Reopen in Container

运行 up 命令

运行下面的命令：

azd up

运行 azd up 命令时，系统会提示你提供以下信息：

参数	说明
Azure Location	您的资源将部署的 Azure 位置。
Azure Subscription	要在其中部署资源的 Azure 订阅。

azd up 命令可能需要一些时间才能运行，因为它完成以下步骤：

• 创建和配置所有必要的Azure资源（azd provision），包括：
  • 帐户的访问策略和角色
  • 使用托管标识的服务到服务通信
• 打包并部署代码 (azd deploy)

提供必需的参数和 azd up 命令完成后，CLI 会显示两个Azure门户链接以查看创建的资源：

• ToDo API 应用
• ToDo Web 应用前端

注意事项

你可以根据需要多次运行 azd up，以便将应用程序预配和部署到同一区域，并使用你在第一次运行时提供的相同配置值。

清理资源

当不再需要本文中创建的 Azure 资源时，请运行以下命令关闭应用：

azd down

如果要重新部署到其他区域，请删除 .azure 目录，然后再次运行 azd up。 在更高级的情况下，可以选择性地编辑 .azure 目录中的文件以更改区域。

请求帮助

有关如何提交 bug、请求帮助或为 Azure 开发人员 CLI 提出新功能的信息，请访问 troubleshooting and support 页。

后续步骤

• 了解如何使用 azd 运行和调试应用。
• 使用 Azure Developer CLI（azd）时排查常见问题
• 读取Azure开发人员 CLI 常见问题解答（常见问题解答）。