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

教程:使用托管标识从应用服务连接到 Azure 数据库,而无需使用密钥

应用服务在 Azure 中提供高度可缩放、自修补的 Web 托管服务。 它还为应用提供托管标识,这是一项统包解决方案,可以确保安全地访问 Azure SQL 数据库,包括:

注意

本教程不包括 Azure Cosmos DB 指南,该指南支持以不同的方式进行 AMicrosoft Entra 身份验证。 有关详细信息,请参阅 Azure Cosmos DB 文档,例如使用系统分配的托管标识访问 Azure Cosmos DB 数据

应用服务中的托管标识可以让应用更安全,因为不需在应用中存储机密,例如连接字符串中的凭据。 本教程介绍如何使用托管标识从应用服务连接到上述数据库。

要学习的知识:

  • 将 Microsoft Entra 用户配置为 Azure 数据库的管理员。
  • 以 Microsoft Entra 用户身份连接数据库。
  • 为应用服务应用配置系统分配或用户分配的托管标识。
  • 授予数据库访问托管标识的权限。
  • 使用托管标识从代码 (.NET Framework 4.8、.NET 6、Node.js、Python、Java) 连接到 Azure 数据库。
  • 以 Microsoft Entra 用户身份从开发环境连接到 Azure 数据库。

如果没有 Azure 订阅,请在开始之前创建一个 Azure 免费帐户

先决条件

  • 基于 .NET、Node.js、Python 或 Java 在应用服务中创建应用。
  • 使用 Azure SQL 数据库、Azure Database for MySQL 或 Azure Database for PostgreSQL 创建数据库服务器。
  • 应熟悉标准连接模式(使用用户名和密码),并且能够成功从应用服务应用连接到所选的数据库。

为 Azure CLI 准备环境。

1.安装服务连接器无密码扩展

为 Azure CLI 安装最新服务连接器无密码扩展:

az extension add --name serviceconnector-passwordless --upgrade

注意

请通过运行 az version,检查扩展“serviceconnector-passwordless”的版本是否为“2.0.2”或更高版本。 可能需要先升级 Azure CLI 才能升级扩展版本。

2.创建无密码连接

接下来,使用服务连接器创建无密码连接。

提示

Azure 门户可以帮助编写以下命令。 在 Azure 门户中,转到 Azure 应用服务资源,从左侧菜单中选择“服务连接器”,然后选择“创建”。 使用所有必需的参数填写表单。 Azure 自动生成连接创建命令,可以复制该命令以在 CLI 中使用或在 Azure Cloud Shell 中执行。

以下 Azure CLI 命令使用 --client-type 参数。

  1. (可选)运行 az webapp connection create sql -h 以获取支持的客户端类型。

  2. 选择客户端类型并运行相应的命令。 将下面的占位符替换为你自己的信息。

    az webapp connection create sql \
        --resource-group <group-name> \
        --name <server-name> \
        --target-resource-group <sql-group-name> \
        --server <sql-name> \
        --database <database-name> \
        --user-identity client-id=<client-id> subs-id=<subscription-id> \
        --client-type <client-type>
    

此服务连接器命令将在后台完成以下任务:

  • 为 Azure 应用服务托管的应用 <server-name> 启用系统分配的托管标识或分配用户标识。
  • 将 Microsoft Entra 管理员设置为当前已登录用户。
  • 为系统分配的托管标识或用户分配的托管标识添加数据库用户。 向此用户授予数据库 <database-name> 的所有权限。 可以在上述命令输出的连接字符串中找到用户名。
  • 根据数据库类型将名为 AZURE_MYSQL_CONNECTIONSTRINGAZURE_POSTGRESQL_CONNECTIONSTRINGAZURE_SQL_CONNECTIONSTRING 的配置设置为 Azure 资源。
  • 对于应用服务,配置是在“应用设置”边栏选项卡中设置的。

如果在创建连接时遇到任何问题,请参阅故障排除获取帮助。

3、修改代码

  1. 安装依赖项。

    dotnet add package Microsoft.Data.SqlClient
    
  2. 从服务连接器添加的环境变量中获取 Azure SQL 数据库连接字符串。

    using Microsoft.Data.SqlClient;
    
    // AZURE_SQL_CONNECTIONSTRING should be one of the following:
    // For system-assigned managed identity:"Server=tcp:<server-name>.database.windows.net;Database=<database-name>;Authentication=Active Directory Default;TrustServerCertificate=True"
    // For user-assigned managed identity: "Server=tcp:<server-name>.database.windows.net;Database=<database-name>;Authentication=Active Directory Default;User Id=<client-id-of-user-assigned-identity>;TrustServerCertificate=True"
    
    string connectionString = 
        Environment.GetEnvironmentVariable("AZURE_SQL_CONNECTIONSTRING")!;
    
    using var connection = new SqlConnection(connectionString);
    connection.Open();
    

    有关详细信息,请参阅使用 Active Directory 托管标识身份验证

有关详细信息,请参阅 Microsoft SQL Server 客户端编程的主页。 有关代码示例,请参阅通过服务连接器创建与数据库服务的无密码连接

4、设置开发环境

此代码示例使用 DefaultAzureCredential 从 Microsoft Entra ID 为 SQL 数据库获取可使用的令牌,然后将其添加到数据库连接。 虽然可以自定义 DefaultAzureCredential,但默认情况下已广泛适用。 它从已登录的 Microsoft Entra 用户或托管标识获取令牌,具体取决于是在开发环境中还是在应用服务本地运行。

无需进一步更改,代码即可在 Azure 中运行。 但是,若要在本地调试代码,开发环境需要已登录 Microsoft Entra 的用户。 在此步骤中,你将以 Microsoft Entra 用户身份登录来配置所选环境。

  1. Visual Studio for Windows 集成了 Microsoft Entra 身份验证。 若要在 Visual Studio 中启用开发和调试,请在 Visual Studio 中添加 Microsoft Entra 用户,方法是从菜单中依次选择“文件”>“帐户设置”,然后选择“登录”“添加”

  2. 若要设置进行 Azure 服务身份验证的 Microsoft Entra 用户,请从菜单中依次选择“工具”>“选项”,然后依次选择“Azure 服务身份验证”>“帐户选择”。 选择已添加的 Microsoft Entra 用户,然后选择“确定”

有关为 Microsoft Entra 身份验证设置开发环境的详细信息,请参阅适用于 .NET 的 Azure 标识客户端库

现已准备好将 SQL 数据库作为后端,使用 Microsoft Entra 身份验证来开发和调试应用程序。

5、测试并发布

  1. 在开发环境中运行代码。 代码使用环境中的已登录 Microsoft Entra 用户连接到后端数据库。 用户可以访问数据库,因为该用户已配置为数据库的 Microsoft Entra 管理员。

  2. 使用首选发布方法将代码发布到 Azure。 在应用服务中,代码使用应用的托管标识连接到后端数据库。

常见问题

托管标识是否支持 SQL Server?

是的。 有关详细信息,请参阅:

我收到错误 Login failed for user '<token-identified principal>'.

尝试为其请求令牌的托管标识无权访问 Azure 数据库。

我更改了应用服务身份验证或关联的应用注册。 为什么我仍然获取旧令牌?

托管标识的后端服务还保留一个令牌缓存,只有在过期的情况下才更新目标资源的令牌。 如果在尝试在使用应用获取令牌修改权限,则在缓存的令牌过期之前,实际上不会获得具有更新权限的新令牌。 解决此问题的最佳方式是使用新的 InPrivate (Edge) /private (Safari) /Incognito (Chrome) 窗口测试更改。 这样一来,请务必从新的经过身份验证的会话开始。

如何将托管标识添加到 Microsoft Entra 组?

如果需要,可将该标识添加到 Microsoft Entra 组,然后将访问权限授予 Microsoft Entra 组,而不是授予该标识。 例如,以下命令将上一步中的托管标识添加到名为 myAzureSQLDBAccessGroup 的新组:

groupid=$(az ad group create --display-name myAzureSQLDBAccessGroup --mail-nickname myAzureSQLDBAccessGroup --query objectId --output tsv)
msiobjectid=$(az webapp identity show --resource-group <group-name> --name <app-name> --query principalId --output tsv)
az ad group member add --group $groupid --member-id $msiobjectid
az ad group member list -g $groupid

若要为 Microsoft Entra 组授予数据库权限,请参阅相应数据库类型的文档。

我收到错误 SSL connection is required. Please specify SSL options and retry

连接到 Azure 数据库需要其他设置,并且超出了本教程的范围。 有关详细信息,请参阅下列相应链接:

在 Azure Database for PostgreSQL 中配置 TLS 连接 - 单一服务器在应用程序中配置 SSL 连接,以便安全地连接到 Azure Database for MySQL

我使用 Web 应用 + 数据库模板创建了应用,现在无法使用服务连接器命令创建托管标识连接。

服务连接器需要对数据库的网络访问权限才能为应用标识授予访问权限。 使用 Web 应用 + 数据库模板在 Azure 门户中创建默认安全的应用和数据库体系结构时,该体系结构会锁定对数据库的网络访问,并且仅允许从虚拟网络内部进行连接。 Azure Cloud Shell 也是如此。 但你可以在虚拟网络中部署 Cloud Shell,然后在该 Cloud Shell 中运服务连接器命令。

后续步骤

你已了解:

  • 将 Microsoft Entra 用户配置为 Azure 数据库的管理员。
  • 以 Microsoft Entra 用户身份连接数据库。
  • 为应用服务应用配置系统分配或用户分配的托管标识。
  • 授予数据库访问托管标识的权限。
  • 使用托管标识从代码 (.NET Framework 4.8、.NET 6、Node.js、Python、Java) 连接到 Azure 数据库。
  • 以 Microsoft Entra 用户身份从开发环境连接到 Azure 数据库。