你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

教程:将 ASP.NET Core 和 Azure SQL 数据库应用部署到 Azure 应用服务

本教程介绍如何将数据驱动 ASP.NET Core 应用部署到 Azure 应用服务并连接到 Azure SQL 数据库。 你还将部署 Azure Cache for Redis 以在应用程序中启用缓存代码。 Azure 应用服务是一种可缩放程度高、支持自修补的 Web 托管服务,可轻松地在 Windows 或 Linux 上部署应用。 尽管本教程使用 ASP.NET Core 8.0 应用,但对于其他版本的 ASP.NET Core 而言,此过程是相同的。

本教程介绍如何执行下列操作:

  • 创建默认安全的应用服务、SQL 数据库和 Redis 缓存体系结构。
  • 使用托管标识和 Key Vault 引用来保护连接机密。
  • 将示例 ASP.NET Core 应用从 GitHub 存储库部署到应用服务。
  • 在应用程序代码中访问应用服务连接字符串和应用设置。
  • 进行更新并重新部署应用程序代码。
  • 通过上传迁移捆绑包生成数据库架构。
  • 从 Azure 流式传输诊断日志。
  • 在 Azure 门户中管理应用。
  • 使用 Azure Developer CLI 预配同一体系结构并进行部署。
  • 使用 GitHub Codespaces 和 GitHub Copilot 优化开发工作流。

先决条件

  • 具有活动订阅的 Azure 帐户。 如果没有 Azure 帐户,可以免费创建一个
  • 一个 GitHub 帐户。 你也可以免费获得一个
  • 了解 ASP.NET Core 开发。
  • (可选)若要试用 GitHub Copilot,请创建一个 GitHub Copilot 帐户。 有 30 天免费试用版可用。

跳到末尾

可以快速部署本教程中的示例应用,并查看它是否在 Azure 中运行。 只需在 Azure Cloud Shell 中运行以下命令,然后按照提示操作:

dotnet tool install --global dotnet-ef
mkdir msdocs-app-service-sqldb-dotnetcore
cd msdocs-app-service-sqldb-dotnetcore
azd init --template msdocs-app-service-sqldb-dotnetcore
azd up

1.运行示例

首先,将示例数据驱动的应用设置为起点。 为方便起见,示例存储库包含一个开发容器配置。 开发容器包含开发应用程序所需的所有内容,包括示例应用程序所需的数据库、缓存和所有环境变量。 开发容器可以在 GitHub codespace 中运行,这意味着可使用 Web 浏览器在任何计算机上运行示例。

步骤 1:在新浏览器窗口中:

  1. 登录到 GitHub 帐户。
  2. 导航到 https://github.com/Azure-Samples/msdocs-app-service-sqldb-dotnetcore/fork
  3. 取消选择“仅复制主分支”。 需要所有分支。
  4. 选择“创建分支”。

显示如何创建示例 GitHub 存储库分支的屏幕截图。

步骤 2:在 GitHub 分支中:

  1. 为起始分支选择“”>“starter-no-infra”。 此分支仅包含示例项目,不包含与 Azure 相关的文件或配置。
  2. 选择“代码”>“在 starter-no-infra 上创建 codespace”。 设置 codespace 需要几分钟时间。

显示如何在 GitHub 中创建 codespace 的屏幕截图。

步骤 3:在 codespace 终端中

  1. 使用 dotnet ef database update 运行数据库迁移。
  2. 使用 dotnet run 运行应用。
  3. 看到通知 Your application running on port 5093 is available. 时,选择“在浏览器中打开”。 应在新的浏览器选项卡中看到该示例应用程序。若要停止应用程序,请键入 Ctrl+C

显示如何在 GitHub codespace 中运行示例应用程序的屏幕截图。

提示

可以向 GitHub Copilot 询问有关此存储库的信息。 例如:

  • @workspace 这个项目有什么用?
  • @workspace .devcontainer 文件夹有什么用?

遇到问题? 检查故障排除部分

2.创建应用服务、数据库和缓存

此步骤创建 Azure 资源。 本教程中使用的步骤创建一组默认安全的资源,其中包括应用服务、Azure SQL 数据库和 Azure 缓存。 此创建过程中,你将指定:

  • Web 应用的名称。 它以 https://<app-name>-<hash>.<region>.azurewebsites.net 的形式用作应用的 DNS 名称的一部分。
  • “区域”,在世界上以物理方式运行应用。 它还用作应用的 DNS 名称的一部分。
  • 应用的运行时堆栈。 在此处选择要用于应用的 .NET 版本。
  • 应用的托管计划。 它是定价层,包括应用的一组功能和缩放容量。
  • 应用的资源组。 使用资源组可将应用程序所需的所有 Azure 资源分组到一个逻辑容器中。

登录到 Azure 门户并按照以下步骤创建 Azure 应用服务资源。

步骤 1:在 Azure 门户中:

  1. 在 Azure 门户顶部的搜索栏中,输入“Web 应用数据库”。
  2. 选择“市场”标题下标记为“Web 应用 + 数据库”的项目。 还可以直接导航到创建向导

显示如何使用顶部工具栏中的搜索框查找“Web 应用 + 数据库”创建向导的屏幕截图。

步骤 2:在“创建 Web 应用 + 数据库”页上,按下面所述填写表单。

  1. 资源组:选择“新建”,并使用名称 msdocs-core-sql-tutorial
  2. 区域:你附近的任何 Azure 区域。
  3. 名称msdocs-core-sql-XYZ,其中 XYZ 是任意三个随机字符。 该名称在 Azure 中必须唯一。
  4. 运行时堆栈.NET 8 (LTS)
  5. 引擎:SQLAzure。 Azure SQL 数据库是一个完全托管的平台即服务 (PaaS) 数据库引擎,始终运行于最新稳定版 SQL Server。
  6. 添加 Azure Cache for Redis?
  7. 托管计划基本。 准备就绪后,可以纵向扩展到生产定价层。
  8. 选择“查看 + 创建”。
  9. 验证完成后,选择“创建”。

显示如何在“Web 应用 + 数据库”向导中配置新应用程序和数据库的屏幕截图。

步骤 3:该部署需要数分钟才能完成。 部署完成后,选择“转到资源”按钮。 这将直接转到应用服务应用,但会创建以下资源:

  • 资源组:所有已创建资源的容器。
  • 应用服务计划:为应用服务定义计算资源。 将创建基本层中的 Linux 计划。
  • 应用服务:表示应用并在应用服务计划中运行。
  • 虚拟网络:与应用服务应用集成,并隔离后端网络流量。
  • 专用终结点:虚拟网络中的密钥保管库、数据库服务器和 Redis 缓存的访问终结点。
  • 网络接口:表示专用 IP 地址,每个专用终结点各一个。
  • Azure SQL 数据库服务器:只能从专用终结点后面访问。
  • Azure SQL 数据库:你的数据库和用户创建于此服务器上。
  • Azure Cache for Redis:只能从专用终结点后面访问。
  • 密钥保管库:只能从其专用终结点后面访问。 用于管理应用服务应用的机密。
  • 专用 DNS 区域:启用虚拟网络中的密钥保管库、数据库服务器和 Redis 缓存的 DNS 解析。

屏幕截图显示已完成的部署过程。

3.安全连接机密

创建向导已生成作为 .NET 连接字符串应用设置的连接字符串。 但是,安全最佳做法是将机密完全排除在应用服务之外。 你需要借助服务连接器将机密移动到密钥保管库,并将应用设置更改为 Key Vault 引用

提示

若要使用无密码身份验证,请参阅如何更改 SQL 数据库连接以改用托管标识?

步骤 1:在“应用服务”页中:

  1. 在左侧菜单中,选择“设置”>“环境变量”>“连接字符串”
  2. 选择“AZURE_SQL_CONNECTIONSTRING”
  3. 在“添加/编辑连接字符串”的“值”字段中,找到字符串末尾的“Password=”部分。
  4. 复制“Password=”后的密码字符串供以后使用。 此连接字符串允许连接到受专用终结点保护的 SQL 数据库。 密码将直接保存在应用服务应用中,这并非最佳处理方式。 同样,“应用设置”选项卡中的 Redis 缓存连接字符串将包含机密。 你将对此进行更改。

显示如何查看应用设置值的屏幕截图。

步骤 2:创建密钥保管库以安全管理机密。

  1. 在顶部搜索栏中,键入“密钥保管库”,然后选择“市场”>“密钥保管库”。
  2. 在“资源组”中,选择“msdocs-core-sql-tutorial”
  3. 在“密钥保管库名称”中,键入仅包含字母和数字的名称。
  4. 在“区域”中,将其设置为资源组的示例位置。

显示如何创建密钥保管库的屏幕截图。

步骤 3:

  1. 选择“网络”选项卡。
  2. 取消选择“启用公共访问”
  3. 选择“创建专用终结点”。
  4. 在“资源组”中,选择“msdocs-core-sql-tutorial”
  5. 在“密钥保管库名称”中,键入仅包含字母和数字的名称。
  6. 在“区域”中,将其设置为资源组的示例位置。
  7. 在对话框中,在“位置”中,选择与应用服务应用相同的位置。
  8. 在“资源组”中,选择“msdocs-core-sql-tutorial”
  9. 在“名称”中,键入“msdocs-core-sql-XYZVvaultEndpoint”
  10. 在“虚拟网络”中,选择“msdocs-core-sql-XYZVnet”
  11. 在“子网”中,选择“msdocs-core-sql-XYZSubnet”
  12. 选择“确定”
  13. 依次选择“查看 + 创建”、“创建”。 等待密钥保管库部署完成。 应会看到“部署已完成”。

屏幕截图显示了如何使用专用终结点保护密钥保管库。

步骤 4:

  1. 在顶部搜索栏中,键入“msdocs-core-sql”,然后键入名为“msdocs-core-sql-XYZ”的应用服务资源。
  2. 在应用服务页面的左侧菜单中,选择“设置”>“服务连接器”。 已经有两个连接器,这是应用创建向导为你创建的。
  3. 选中 SQL 数据库连接器旁边的复选框,然后选择“编辑”
  4. 选择“身份验证”选项卡。
  5. 在“密码”中,粘贴你之前复制的密码。
  6. 选择“在密钥保管库中存储机密”。
  7. 在“密钥保管库连接”下,选择“创建新连接”。 在编辑对话框顶部打开“创建连接”对话框。

该屏幕截图显示了如何编辑使用密钥保管库连接的 SQL 数据库服务连接器。

步骤 5:在密钥保管库连接的“创建连接”对话框中:

  1. 在“密钥保管库”中选择之前创建的密钥保管库。
  2. 选择“查看 + 创建” 。 应该会看到“系统分配的托管标识”设置为“已选中”。
  3. 验证完成后,选择“创建”。

该屏幕截图显示了如何创建密钥保管库服务连接器。

步骤 6:返回“defaultConnector”的编辑对话框中。

  1. 在“身份验证”选项卡中,等待创建密钥保管库连接器。 完成后,“密钥保管库连接”下拉列表会自动选择相应选项。
  2. 选择“下一页:网络”。
  3. 选择“配置防火墙规则以启用对目标服务的访问权限”。 应用创建向导已使用专用终结点保护 SQL 数据库。
  4. 选择“保存”。 等待“更新成功”通知出现

该屏幕截图显示了 SQL 数据库服务连接器中选择的密钥保管库连接。

步骤 7:在“服务连接器”页面中:

  1. 选中“Redis 缓存”连接器旁边的复选框,然后选择“编辑”。
  2. 选择“身份验证”选项卡。
  3. 选择“在密钥保管库中存储机密”。
  4. 在“密钥保管库连接”下,选择创建的密钥保管库。
  5. 选择“下一页:网络”。
  6. 选择“配置防火墙规则以启用对目标服务的访问权限”。 应用创建向导已使用专用终结点保护 SQL 数据库。
  7. 选择“保存”。 等待“更新成功”通知出现

该屏幕截图显示了如何编辑使用密钥保管库连接的 Redis 缓存服务连接器。

步骤 8:验证所做的更改:

  1. 在左侧菜单中,再次选择“环境变量”>“连接字符串”
  2. 在“AZURE_SQL_CONNECTIONSTRING”旁边,选择“显示值”。 该值应为 @Microsoft.KeyVault(...),这意味着它是 密钥保管库引用,因为密钥保管库中现在管理机密。
  3. 若要验证 Redis 连接字符串,请选择“应用设置”选项卡。在“AZURE_REDIS_CONNECTIONSTRING”旁边,选择“显示值”。 该值也应为 @Microsoft.KeyVault(...)

该屏幕截图显示了如何在 Azure 中查看 .NET 连接字符串的值。

4.部署示例代码

在此步骤中,使用 GitHub Actions 配置 GitHub 部署。 这只是部署到应用服务的许多方法之一,也是一种在部署过程中持续集成的好方法。 默认情况下,进入 GitHub 存储库的每个 git push 都会启动生成和部署操作。

步骤 1:在左侧菜单中,选择“部署”>“部署中心”。

显示如何在“应用服务”中打开部署中心的屏幕截图。

步骤 2:在“部署中心”页中:

  1. 在“源”中,选择“GitHub”。 默认情况下,选择 GitHub Actions 作为生成提供程序。
  2. 登录到 GitHub 帐户,并按照提示授权 Azure。
  3. 在“组织”中,选择你的帐户。
  4. 在“存储库”中,选择“msdocs-app-service-sqldb-dotnetcore”。
  5. 在“分支”中,选择“starter-no-infra”。 这是与示例应用一起使用的同一分支,不包含任何与 Azure 相关的文件或配置。
  6. 对于“身份验证类型”,请选择“用户分配的标识”。
  7. 在顶部菜单中,选择“保存”。 应用服务会将工作流文件提交到所选 GitHub 存储库中(在 .github/workflows 目录中)。 默认情况下,部署中心会为工作流创建用户分配的标识,以便使用 Microsoft Entra(OIDC 身份验证)进行身份验证。 有关身份验证选项的详细信息,请参阅使用 GitHub Actions 部署到应用服务

显示如何使用 GitHub Actions 配置 CI/CD 的屏幕截图。

步骤 3:返回示例分支的 GitHub codespace,运行 git pull origin starter-no-infra。 这会将新提交的工作流文件拉取到 codespace。

显示 GitHub codespace 内的 git 拉取的屏幕截图。

步骤 4(选项 1:使用 GitHub Copilot):

  1. 选择“聊天”视图,然后选择 +,即可开始新的聊天会话。
  2. 问:“@workspace 应用如何连接到数据库和缓存?”Copilot 可能会提供有关 MyDatabaseContext 类以及如何在 Program.cs 中进行配置的一些说明。
  3. 问:“在生产模式下,我希望应用程序对数据库使用名为 AZURE_SQL_CONNECTIONSTRING 的连接字符串,并使用名为 AZURE_REDIS_CONNECTIONSTRING 的应用设置*。”Copilot 可能会向你提供与下面的“选项 2:不使用 GitHub Copilot”步骤中的代码建议类似的代码建议,甚至会告诉你在 Program.cs 文件中进行更改。
  4. 在资源管理器中打开 Program.cs 并添加代码建议。 GitHub Copilot 不会每次都提供相同的响应,而且并不总是正确的。 可能需要提出更多问题来微调其响应。 有关提示,请参阅我可以在 codespace 中使用 GitHub Copilot 做什么?

屏幕截图显示如何在新的 GitHub Copilot 聊天会话中提问。

步骤 4(选项 2:不使用 GitHub Copilot):

  1. 在资源管理器中打开 Program.cs
  2. 找到注释的代码(第 12-21 行),并取消注释。 此代码通过使用 AZURE_SQL_CONNECTIONSTRING 连接到数据库,并使用应用设置 AZURE_REDIS_CONNECTIONSTRING 连接到 Redis 缓存。

显示 GitHub codespace 和已打开的 Program.cs 文件的屏幕截图。

步骤 5(选项 1:使用 GitHub Copilot):

  1. 在资源管理器中打开 .github/workflows/starter-no-infra_msdocs-core-sql-XYZ。 此文件由应用服务创建向导创建。
  2. 突出显示 dotnet publish 步骤并选择
  3. 让 Copilot 执行以下操作:“安装 dotnet ef,然后在同一输出文件夹中创建迁移捆绑包。
  4. 如果建议是可接受的,请选择“接受”。 GitHub Copilot 不会每次都提供相同的响应,而且并不总是正确的。 可能需要提出更多问题来微调其响应。 有关提示,请参阅我可以在 codespace 中使用 GitHub Copilot 做什么?

显示在 GitHub 工作流文件中使用 GitHub Copilot 的屏幕截图。

步骤 5(选项 2:不使用 GitHub Copilot):

  1. 在资源管理器中打开 .github/workflows/starter-no-infra_msdocs-core-sql-XYZ。 此文件由应用服务创建向导创建。
  2. dotnet publish 步骤下,添加一个步骤,以使用命令 dotnet tool install -g dotnet-ef --version 8.* 安装 Entity Framework Core 工具
  3. 在新步骤下,添加另一个步骤以在部署包中生成数据库迁移捆绑包dotnet ef migrations bundle --runtime linux-x64 -o ${{env.DOTNET_ROOT}}/myapp/migrationsbundle。 迁移捆绑包是一个自包含的可执行文件,无需 .NET SDK 即可在生产环境中运行。 应用服务 Linux 容器只有 .NET 运行时,没有 .NET SDK。

显示添加到数据库迁移捆绑包的 GitHub 工作流文件的步骤的屏幕截图。

步骤 6:

  1. 选择“源代码管理”扩展。
  2. 在文本框中,键入类似 Configure Azure database and cache connections 的提交消息。 或者,选择 ,让 GitHub Copilot 为你生成提交消息。
  3. 选择“提交”,然后使用“是”进行确认
  4. 选择“同步更改 1”,然后使用“确定”进行确认。

显示正在提交并推送到 GitHub 的更改的屏幕截图。

步骤 7:返回到 Azure 门户中的“部署中心”页:

  1. 选择“日志”选项卡,然后选择“刷新”以查看新的部署运行。
  2. 在部署运行的日志项中,选择具有最新时间戳的“生成/部署日志”条目。

显示如何在部署中心打开部署日志的屏幕截图。

步骤 8:你已转到 GitHub 存储库,并看到 GitHub Action 正在运行。 工作流文件定义两个单独的阶段,即生成和部署阶段。 等待 GitHub 运行以显示“成功”状态。 此过程大约需要 5 分钟。

屏幕截图显示 GitHub 正在运行。

5.生成数据库架构

在 SQL 数据库受虚拟网络保护的情况下,运行 dotnet 数据库迁移的最简单方法是使用应用服务容器在 SSH 会话中运行。

步骤 1:返回“应用服务”页,在左侧菜单中,选择“开发工具”>“SSH”,然后选择“转到”。

显示如何从 Azure 门户打开应用的 SSH shell 的屏幕截图。

步骤 2:在 SSH 终端中:

  1. 运行 cd /home/site/wwwroot。 下面是所有已部署的文件。
  2. 使用命令 ./migrationsbundle -- --environment Production 运行由 GitHub 工作流生成的迁移捆绑包。 如果该命令成功,则应用服务会成功连接到 SQL 数据库。 请记住,--environment Production 对应于你在 Program.cs 中所做的代码更改。

显示在 SSH shell 中运行的命令及其输出的屏幕截图。

在 SSH 会话中,只有在 /home 中对文件进行的更改才能在应用重启后保持。 不会保留 /home 外部的更改。

遇到问题? 检查故障排除部分

6.浏览到应用

步骤 1:在“应用服务”页中:

  1. 从左侧菜单中选择“概述”。
  2. 选择应用的 URL。

显示如何从 Azure 门户中启动应用服务的屏幕截图。

步骤 2:将一些任务添加到列表。 恭喜,你已在 Azure 应用服务中运行了一个安全的数据驱动的 ASP.NET Core 应用。

在应用服务中运行的 .NET Core 应用的屏幕截图。

提示

示例应用程序实现缓存端模式。 当你第二次访问一个数据视图,或在进行数据更改后重新加载同一页时,网页中显示的“处理时间”会快得多,因为它是从缓存而不是从数据库加载数据。

7.流式传输诊断日志

Azure 应用服务捕获已记录到控制台的所有消息,以帮助你诊断应用程序的问题。 示例应用在其每个终结点中输出控制台日志消息,以演示此功能。

步骤 1:在“应用服务”页中:

  1. 在左侧菜单中,选择“监视”>“应用服务日志”。
  2. 在“应用程序日志记录”下,选择“文件系统”,然后选择“保存”。

显示如何在 Azure 门户的应用服务中启用本机日志的屏幕截图。

步骤 2:在左侧菜单中,选择“日志流”。 将显示应用的日志,包括平台日志和容器内部的日志。

显示如何在 Azure 门户中查看日志流的屏幕截图。

8.清理资源

完成后,可以通过删除资源组从 Azure 订阅中删除所有资源。

步骤 1:在 Azure 门户顶部的搜索栏中:

  1. 输入资源组名称。
  2. 选择前面创建的资源组。

显示如何在 Azure 门户中搜索和导航到资源组的屏幕截图。

步骤 2:在资源组页上,选择“删除资源组”。

显示 Azure 门户中“删除资源组”按钮位置的屏幕截图。

步骤 3:

  1. 输入资源组名称以确认删除。
  2. 选择“删除”。

Azure 门户中删除资源组确认对话框的屏幕截图。

2.创建 Azure 资源并部署示例应用

在此步骤中,将创建 Azure 资源并将示例应用部署到 Linux 上的应用服务。 本教程中使用的步骤创建一组默认安全的资源,其中包括应用服务、Azure SQL 数据库和 Azure Cache for Redis。

开发容器已具有 Azure Developer CLI (AZD)。

  1. 从存储库根路径,运行 azd init

    azd init --template dotnet-app-service-sqldb-infra
    
  2. 出现提示时,请提供以下答案:

    问题 Answer
    当前目录不为空。 是否要在此处初始化“<your-directory>”中的项目? Y
    你希望对这些文件执行哪些操作? 使现有文件保持不变
    输入新环境名称 键入唯一名称。 AZD 模板将此名称用作 Azure 中 Web 应用的 DNS 名称的一部分 (<app-name>-<hash>.azurewebsites.net)。 允许使用字母数字字符和下划线。
  3. 通过运行 azd auth login 命令并按照提示登录到 Azure:

    azd auth login
    
  4. 使用 azd up 命令创建必要的 Azure 资源并部署应用代码。 按照提示为 Azure 资源选择所需的订阅和位置。

    azd up
    

    azd up 命令需要大约 15 分钟来完成(Redis 缓存需要的时间最长)。 它还会编译和部署应用程序代码,但你稍后将修改代码以使用应用服务。 在运行时,该命令会提供有关预配和部署过程的消息,包括指向 Azure 中部署的链接。 完成后,命令还会显示指向部署应用程序的链接。

    此 AZD 模板包含使用以下 Azure 资源生成安全默认体系结构的文件(azure.yamlinfra 目录):

    • 资源组:所有已创建资源的容器。
    • 应用服务计划:为应用服务定义计算资源。 将创建基本层中的 Linux 计划。
    • 应用服务:表示应用并在应用服务计划中运行。
    • 虚拟网络:与应用服务应用集成,并隔离后端网络流量。
    • 专用终结点:虚拟网络中的密钥保管库、数据库服务器和 Redis 缓存的访问终结点。
    • 网络接口:表示专用 IP 地址,每个专用终结点各一个。
    • Azure SQL 数据库服务器:只能从专用终结点后面访问。
    • Azure SQL 数据库:你的数据库和用户创建于此服务器上。
    • Azure Cache for Redis:只能从专用终结点后面访问。
    • 密钥保管库:只能从其专用终结点后面访问。 用于管理应用服务应用的机密。
    • 专用 DNS 区域:启用虚拟网络中的密钥保管库、数据库服务器和 Redis 缓存的 DNS 解析。

    一旦命令完成创建资源和首次部署应用程序代码的操作,已部署的示例应用就无法运行,因为你必须进行微小的更改才能使其连接到 Azure 中的数据库。

遇到问题? 检查故障排除部分

3.验证连接字符串

提示

默认 SQL 数据库连接字符串使用 SQL 身份验证。 有关更安全的无密码身份验证,请参阅如何更改 SQL 数据库连接以改用托管标识?

你使用的 AZD 模板已为你生成了连接变量作为应用设置,并将它们输出到终端,以方便你使用。 使用应用设置可以将连接机密保留在代码存储库之外。

  1. 在 AZD 输出中,找到设置 AZURE_SQL_CONNECTIONSTRINGAZURE_REDIS_CONNECTIONSTRING。 只显示设置名称。 它们在 AZD 输出中如下所示:

     App Service app has the following connection strings:
         - AZURE_SQL_CONNECTIONSTRING
         - AZURE_REDIS_CONNECTIONSTRING
         - AZURE_KEYVAULT_RESOURCEENDPOINT
         - AZURE_KEYVAULT_SCOPE
     

    AZURE_SQL_CONNECTIONSTRING 包含 Azure 中 SQL 数据库的连接字符串,而 AZURE_REDIS_CONNECTIONSTRING 则包含 Azure Redis 缓存的连接字符串。 稍后需要在代码中使用它们。

  2. 为方便起见,AZD 模板会显示应用的应用设置页的直接链接。 找到该链接并在新的浏览器选项卡中打开它。

遇到问题? 检查故障排除部分

4.修改示例代码并重新部署

  1. 在 GitHub codespace 中,选择“聊天”视图,然后选择 +,即可开始新的聊天会话。

  2. 问:“@workspace 应用如何连接到数据库和缓存?”Copilot 可能会提供有关 MyDatabaseContext 类以及如何在 Program.cs 中进行配置的一些说明。

  3. 问:“在生产模式下,我希望应用程序对数据库使用名为 AZURE_SQL_CONNECTIONSTRING 的连接字符串,并使用名为 AZURE_REDIS_CONNECTIONSTRING 的应用设置*。”Copilot 可能会向你提供与下面的“选项 2:不使用 GitHub Copilot”步骤中的代码建议类似的代码建议,甚至会告诉你在 Program.cs 文件中进行更改。

  4. 在资源管理器中打开 Program.cs 并添加代码建议。

    GitHub Copilot 不会每次都提供相同的响应,而且并不总是正确的。 可能需要提出更多问题来微调其响应。 有关提示,请参阅我可以在 codespace 中使用 GitHub Copilot 做什么?

在部署这些更改之前,仍需要生成迁移捆绑包。

遇到问题? 检查故障排除部分

5.生成数据库架构

在 SQL 数据库受虚拟网络保护的情况下,运行数据库迁移的最简单方法是使用应用服务容器在 SSH 会话中运行。 但是,应用服务 Linux 容器没有 .NET SDK,因此运行数据库迁移的最简单方法是上传独立迁移捆绑包。

  1. 使用以下命令为项目生成迁移捆绑包:

    dotnet ef migrations bundle --runtime linux-x64 -o migrationsbundle
    

    提示

    示例应用程序(请参阅 DotNetCoreSqlDb.csproj)配置为包含此 migrationsbundle 文件。 在 azd package 阶段,migrationsbundle 将添加到部署包。

  2. 使用 azd up 部署所有更改。

    azd up
    
  3. 在 azd 输出中,找到 SSH 会话的 URL,并在浏览器中导航到该 URL。 它在输出中如下所示:

     Open SSH session to App Service container at: https://<app-name>-<hash>.scm.azurewebsites.net/webssh/host
     
  4. 在 SSH 终端中,运行以下命令:

    cd /home/site/wwwroot
    ./migrationsbundle -- --environment Production
    

    如果该命令成功,则应用服务会成功连接到数据库。 请记住,--environment Production 对应于你在 Program.cs 中所做的代码更改。

在 SSH 会话中,只有在 /home 中对文件进行的更改才能在应用重启后保持。 不会保留 /home 外部的更改。

遇到问题? 检查故障排除部分

6.浏览到应用

  1. 在 AZD 输出中,找到应用的 URL 并在浏览器中导航到该 URL。 该 URL 在 AZD 输出中如下所示:

     Deploying services (azd deploy)
    
       (✓) Done: Deploying service web
       - Endpoint: https://<app-name>-<hash>.azurewebsites.net/
     
  2. 将一些任务添加到列表。

    使用在 Azure 中运行的 SQL 数据库的 ASP.NET Core Web 应用的屏幕截图,其中显示了任务。

    恭喜,你已在 Azure 应用服务中运行了一个 Web 应用,并安全连接到了 Azure SQL 数据库。

遇到问题? 检查故障排除部分

7.流式传输诊断日志

Azure 应用服务可以捕获控制台日志,以帮助你诊断应用程序的问题。 为方便起见,AZD 模板已启用对本地文件系统的日志记录以及将日志传送到 Log Analytics 工作区

示例应用程序包括标准日志记录语句,用于演示此功能,如以下代码片段所示:

public async Task<IActionResult> Index()
{
    var todoItems = await _cache.GetAsync(_TodoItemsCacheKey);
    if (todoItems != null)
    {
        _logger.LogInformation("Data from cache.");
        var todoList = JsonConvert.DeserializeObject<List<Todo>>(Encoding.UTF8.GetString(todoItems));
        return View(todoList);
    }
    else
    {
        _logger.LogInformation("Data from database.");
        var todoList = await _context.Todo.ToListAsync();
        var serializedTodoList = JsonConvert.SerializeObject(todoList);
        await _cache.SetAsync(_TodoItemsCacheKey, Encoding.UTF8.GetBytes(serializedTodoList));
        return View(todoList);
    }
}

在 AZD 输出中,找到流式传输应用服务日志的链接,并在浏览器中导航到该链接。 该链接在 AZD 输出中如下所示:

Stream App Service logs at: https://portal.azure.com/#@/resource/subscriptions/<subscription-guid>/resourceGroups/<group-name>/providers/Microsoft.Web/sites/<app-name>/logStream

为 .NET、Node.js、Python 和 Java 应用程序启用 Azure Monitor OpenTelemetry 系列中详细了解 .NET 应用中的日志记录。

遇到问题? 检查故障排除部分

8.清理资源

若要删除当前部署环境中的所有 Azure 资源,请运行 azd down 并按照提示进行操作。

azd down

故障排除

Azure SQL 数据库的门户部署视图显示冲突状态

根据订阅和所选区域,你可能会看到 Azure SQL 数据库的部署状态为 Conflict,并且操作详细信息中显示以下消息:

Location '<region>' is not accepting creation of new Windows Azure SQL Database servers at this time.

此错误很可能是由所选区域的订阅限制引起的。 请尝试为部署选择其他区域。

在 Azure 门户中,Web 应用的日志流 UI 显示网络错误

你可能会看到以下错误:

Unable to open a connection to your app. This may be due to any network security groups or IP restriction rules that you have placed on your app. To use log streaming, please make sure you are able to access your app directly from your current network.

首次启动应用时,这通常是暂时性错误。 请等候几分钟,然后再次查看。

浏览器中的 SSH 会话显示 SSH CONN CLOSED

启动 Linux 容器需要花费几分钟时间。 请等候几分钟,然后再次查看。

门户日志流页显示 Connected!,但没有日志

配置诊断日志后,该应用将重启。 可能需要刷新页面,以便更改在浏览器中生效。

常见问题解答

此设置花费有多大?

所创建资源的定价如下所示:

  • 应用服务计划在基本层中创建,可以进行纵向扩展或缩减。 请参阅应用服务定价
  • Azure SQL 数据库是在具有最少核心数的标准系列硬件上的常规用途无服务器层中创建的。 成本很小,可以分发到其他区域。 可以通过减小其最大大小来进一步降低成本,也可以通过调整服务层、计算层、硬件配置、核心数、数据库大小和区域冗余来纵向扩展成本。 请参阅 Azure SQL 数据库定价
  • Azure Cache for Redis 是在缓存大小最小的基本层中创建的。 此层的相关成本很低。 你可将其纵向扩展到更高的性能层,以实现更高的可用性、聚类分析和其他功能。 请查阅 Azure Cache for Redis 定价
  • 除非配置额外的功能(例如对等互连),否则虚拟网络不会产生费用。 请参阅 Azure 虚拟网络定价
  • 专用 DNS 区域会产生少量费用。 请参阅 Azure DNS 定价

如何使用其他工具连接到在虚拟网络后面受保护的 Azure SQL 数据库服务器?

  • 要从命令行工具进行基本访问,可以从应用的 SSH 终端运行 sqlcmd。 应用的容器不附带 sqlcmd,因此必须手动安装它。 请记住,已安装的客户端不会在应用重启时持久保存。
  • 若要从 SQL Server Management Studio 客户端或 Visual Studio 进行连接,你的计算机必须位于虚拟网络中。 例如,它可以是连接到其中某个子网的 Azure VM,也可以是与 Azure 虚拟网络建立站点到站点 VPN 连接的本地网络中的计算机。

本地应用开发如何处理 GitHub Actions?

以应用服务自动生成的工作流文件为例,每个 git push 文件都会启动新的生成和部署运行。 从 GitHub 存储库的本地克隆中,将所需的更新推送到 GitHub。 例如:

git add .
git commit -m "<some-message>"
git push origin main

如何解决 GitHub Actions 部署期间的错误?

如果自动生成的 GitHub 工作流文件中某个步骤失败,请尝试修改失败的命令以生成更详细的输出。 例如,可通过添加 dotnet 选项从任何 -v 命令中获取更多输出。 提交并推送更改以触发到应用服务的另一个部署。

我无权创建用户分配的标识

请参阅从部署中心设置 GitHub Actions 部署

如何更改 SQL 数据库连接以改用托管标识?

SQL 数据库的默认连接字符串由服务连接器管理,名称为 defaultConnector,并且它使用 SQL 身份验证。 若要将其替换为使用托管标识的连接,请在替换占位符后在 cloud shell 中运行以下命令:

az extension add --name serviceconnector-passwordless --upgrade
az sql server update --enable-public-network true
az webapp connection delete sql --connection defaultConnector --resource-group <group-name> --name <app-name>
az webapp connection create sql --connection defaultConnector --resource-group <group-name> --name <app-name> --target-resource-group <group-name> --server <database-server-name> --database <database-name> --client-type dotnet --system-identity --config-connstr true
az sql server update --enable-public-network false

默认情况下,命令 az webapp connection create sql --client-type dotnet --system-identity --config-connstr 执行以下操作:

  • 将用户设置为 SQL 数据库服务器的 Microsoft Entra ID 管理员。
  • 创建系统分配的托管标识,并向其授予对数据库的访问权限。
  • 生成名为 AZURE_SQL_CONNECTIONGSTRING 的无密码连接字符串,你的应用在本教程结束时已在使用它。

你的应用现在应已连接到 SQL 数据库。 有关详细信息,请参阅教程:使用托管标识从应用服务连接到 Azure 数据库,而无需使用密钥

提示

不想启用公用网络连接? 如果订阅上具有所有者角色分配,则可以从与虚拟网络集成的 Azure Cloud Shell 中运行命令,以便跳过 az sql server update --enable-public-network true

若要向标识授予对受虚拟网络保护的数据库所需的访问权限,az webapp connection create sql 需要通过 Entra ID 身份验证与数据库服务器建立直接连接。 默认情况下,Azure Cloud Shell 无法访问受网络保护的数据库。

我可以在 codespace 中使用 GitHub Copilot 做什么?

你可能已经注意到,创建 codespace 时,GitHub Copilot 聊天视图已经存在。 为了你的方便,我们在容器定义中包含了 GitHub Copilot 聊天扩展(参见 .devcontainer/devcontainer.json)。 不过,你需要一个 GitHub Copilot 帐户(可免费试用 30 天)。

下面是与 GitHub Copilot 交谈时的一些提示:

  • 在单次聊天会话中,问题和答案相互关联,你可以调整问题来微调所获得的答案。
  • 默认情况下,GitHub Copilot 无法访问你存储库中的任何文件。 若要询问有关文件的问题,请首先在编辑器中打开该文件。
  • 为了让 GitHub Copilot 在准备答案时有权访问存储库中的所有文件,请在问题开头加上 @workspace。 有关详细信息,请参阅 Use the @workspace agent
  • 在聊天会话中,GitHub Copilot 可以建议更改,甚至可以(在使用 @workspace 时)建议在何处进行更改,但系统不允许它为你进行更改。 你可以自行添加建议的更改并对其进行测试。

你还可以说下面的一些话来微调得到的答案:

  • 我希望此代码仅在生产模式下运行。
  • 我希望此代码仅在 Azure 应用服务中运行,而不在本地运行。
  • --output-path 参数似乎不受支持。

请继续学习下一教程,了解如何使用自定义域和证书保护应用。

或者,查看其他资源: