快速入门：适用于 .NET 的 Azure 密钥保管库密钥客户端库

项目
09/09/2024

适用于 .NET 的 Azure Key Vault 密钥客户端库入门。 Azure Key Vault 是一项云服务，它为加密密钥提供了安全的存储。可以安全地存储加密密钥、密码、证书和其他机密。可以通过 Azure 门户创建和管理 Azure Key Vault。本快速入门介绍如何使用 .NET 密钥客户端库在 Azure 密钥保管库中创建、检索和删除密钥

Key Vault 密钥客户端库资源：

API 参考文档 | 库源代码 | 包 (NuGet)

有关 Key Vault 和密钥的详细信息，请参阅：

Key Vault 概述
密钥概述。

先决条件

Azure 订阅 - 创建试用版订阅
.NET 6 SDK 或更高版本
Azure CLI
Key Vault - 可以使用 Azure 门户、Azure CLI 或 Azure PowerShell 进行创建。

本快速入门使用 dotnet 和 Azure CLI

设置

本快速入门结合使用 Azure Identity 库和 Azure CLI，向 Azure 服务验证用户身份。开发人员还可以使用 Visual Studio 或 Visual Studio Code 来验证其调用。有关详细信息，请参阅使用 Azure Identity 客户端库对客户端进行身份验证。

运行 login 命令。
```
az cloud set -n AzureChinaCloud
az login
# az cloud set -n AzureCloud   //means return to Public Azure.
```
如果 CLI 可以打开默认浏览器，它将这样做并加载 Azure 登录页。

否则，请在 https://aka.ms/deviceloginchina 处打开浏览器页，然后输入终端中显示的授权代码。
在浏览器中使用帐户凭据登录。

若要通过基于角色的访问控制 (RBAC) 授予应用程序对密钥保管库的权限，请使用 Azure CLI 命令 az role assignment create 分配角色。

az role assignment create --role "Key Vault Secrets User" --assignee "<app-id>" --scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"

若要通过基于角色的访问控制 (RBAC) 授予应用程序对密钥保管库的权限，请使用 Azure PowerShell cmdlet New-AzRoleAssignment 分配角色。

New-AzRoleAssignment -ObjectId "<app-id>" -RoleDefinitionName "Key Vault Secrets User" -Scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.KeyVault/vaults/<your-unique-keyvault-name>"

将 <app-id>、<subscription-id>、<resource-group-name> 和 <your-unique-keyvault-name> 替换为实际值。 <app-id> 是在 Azure Entra 中注册的应用程序的应用程序（客户端）ID。

创建新的 .NET 控制台应用

在命令外壳中，运行以下命令以创建名为 key-vault-console-app 的项目：
```
dotnet new console --name key-vault-console-app
```
切换到新创建的 key-vault-console-app 目录，然后运行以下命令来生成项目：
```
dotnet build
```
生成输出不应包含警告或错误。
```
Build succeeded.
 0 Warning(s)
 0 Error(s)
```

安装包

在命令外壳中，安装适用于 .NET 的 Azure Key Vault 密钥客户端库：

dotnet add package Azure.Security.KeyVault.Keys

对于本快速入门，还需要安装 Azure 标识客户端库：

dotnet add package Azure.Identity

设置环境变量

此应用程序使用 Key Vault 名称作为名为 KEY_VAULT_NAME 的环境变量。

Windows

set KEY_VAULT_NAME=<your-key-vault-name>

Windows PowerShell

$Env:KEY_VAULT_NAME="<your-key-vault-name>"

macOS 或 Linux

export KEY_VAULT_NAME=<your-key-vault-name>

对象模型

适用于 .NET 的 Azure Key Vault 密钥客户端库可用于管理密钥。代码示例部分介绍了如何创建客户端，以及如何设置、检索和删除密钥。

代码示例

添加指令

在 Program.cs 的顶部添加以下指令：

using System;
using Azure.Identity;
using Azure.Security.KeyVault.Keys;

进行身份验证并创建客户端

对大多数 Azure 服务的应用程序请求必须获得授权。要在代码中实现与 Azure 服务的无密码连接，建议使用 Azure 标识客户端库提供的 DefaultAzureCredential 类。 DefaultAzureCredential 支持多种身份验证方法，并确定应在运行时使用哪种方法。通过这种方法，你的应用可在不同环境（本地与生产）中使用不同的身份验证方法，而无需实现特定于环境的代码。

在本快速入门中，DefaultAzureCredential 使用登录到 Azure CLI 的本地开发用户的凭据对密钥保管库进行身份验证。将应用程序部署到 Azure 时，相同的 DefaultAzureCredential 代码可以自动发现并使用分配给应用服务、虚拟机或其他服务的托管标识。有关详细信息，请参阅托管标识概述。

在此示例中，密钥保管库的名称扩展为密钥保管库 URI，格式为 https://<your-key-vault-name>.vault.azure.cn。有关向密钥保管库进行身份验证的详细信息，请参阅开发人员指南。

var keyVaultName = Environment.GetEnvironmentVariable("KEY_VAULT_NAME");
var kvUri = $"https://{keyVaultName}.vault.azure.cn";

var client = new KeyClient(new Uri(kvUri), new DefaultAzureCredential());

保存密钥

对于此任务，请使用 CreateKeyAsync 方法。该方法的参数接受密钥名和密钥类型。

var key = await client.CreateKeyAsync("myKey", KeyType.Rsa);

注意

如果密钥名已存在，则此代码将创建该密钥的新版本。

检索密钥

现在，可以使用 GetKeyAsync 方法检索以前创建的密钥。

var key = await client.GetKeyAsync("myKey");

删除密钥

最后，让我们使用 StartDeleteKeyAsync 和 PurgeDeletedKeyAsync 方法从密钥保管库中删除并清除密钥。

var operation = await client.StartDeleteKeyAsync("myKey");

// You only need to wait for completion if you want to purge or recover the key.
await operation.WaitForCompletionAsync();

var key = operation.Value;
await client.PurgeDeletedKeyAsync("myKey");

示例代码

通过完成以下步骤，将 .NET 控制台应用修改为与密钥保管库交互：

将 Program.cs 中的代码替换为以下代码：

using System;
using System.Threading.Tasks;
using Azure.Identity;
using Azure.Security.KeyVault.Keys;

namespace key_vault_console_app
{
    class Program
    {
        static async Task Main(string[] args)
        {
            const string keyName = "myKey";
            var keyVaultName = Environment.GetEnvironmentVariable("KEY_VAULT_NAME");
            var kvUri = $"https://{keyVaultName}.vault.azure.cn";

            var client = new KeyClient(new Uri(kvUri), new DefaultAzureCredential());

            Console.Write($"Creating a key in {keyVaultName} called '{keyName}' ...");
            var createdKey = await client.CreateKeyAsync(keyName, KeyType.Rsa);
            Console.WriteLine("done.");

            Console.WriteLine($"Retrieving your key from {keyVaultName}.");
            var key = await client.GetKeyAsync(keyName);
            Console.WriteLine($"Your key version is '{key.Value.Properties.Version}'.");

            Console.Write($"Deleting your key from {keyVaultName} ...");
            var deleteOperation = await client.StartDeleteKeyAsync(keyName);
            // You only need to wait for completion if you want to purge or recover the key.
            await deleteOperation.WaitForCompletionAsync();
            Console.WriteLine("done.");

            Console.Write($"Purging your key from {keyVaultName} ...");
            await client.PurgeDeletedKeyAsync(keyName);
            Console.WriteLine(" done.");
        }
    }
}

测试和验证

执行以下命令以生成项目
```
dotnet build
```
执行以下命令来运行应用。
```
dotnet run
```

出现提示时，输入一个密码值。例如，mySecretPassword。

随即显示以下输出的变体：

Creating a key in mykeyvault called 'myKey' ... done.
Retrieving your key from mykeyvault.
Your key version is '8532359bced24e4bb2525f2d2050738a'.
Deleting your key from jl-kv ... done
Purging your key from <your-unique-keyvault-name> ... done.

后续步骤

在本快速入门中，你创建了一个密钥保管库，存储了一个密钥，然后检索了该密钥。

若要详细了解 Key Vault 以及如何将其与应用集成，请参阅以下文章：

通过