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

KeyClient 类

  • 参考

定义

命名空间:
Azure.Security.KeyVault.Keys
程序集:
Azure.Security.KeyVault.Keys.dll
包:
Azure.Security.KeyVault.Keys v4.6.0
包:
Azure.Security.KeyVault.Keys v4.6.0-beta.2
Source:
KeyClient.cs
Source:
KeyClient.cs

KeyClient 提供同步和异步方法，用于在 Azure 密钥保管库中管理KeyVaultKey。 客户端支持创建、检索、更新、删除、清除、备份、还原和列出 KeyVaultKey。 客户端还支持启用软删除的 Azure 密钥保管库列表DeletedKey。

public class KeyClient
type KeyClient = class
Public Class KeyClient
继承
Object
KeyClient

构造函数

KeyClient()

初始化 类的新实例 KeyClient 以便模拟。
KeyClient(Uri, TokenCredential)

为指定的保管库初始化 类的新实例 KeyClient 。
KeyClient(Uri, TokenCredential, KeyClientOptions)

为指定的保管库初始化 类的新实例 KeyClient 。

属性

VaultUri

Uri获取用于创建 的此实例的保管库的 KeyClient。

方法

BackupKey(String, CancellationToken)

请求将指定密钥的备份下载到客户端。
BackupKeyAsync(String, CancellationToken)

请求将指定密钥的备份下载到客户端。
CreateEcKey(CreateEcKeyOptions, CancellationToken)

在 密钥保管库 中创建并存储新的椭圆曲线键。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 此操作需要密钥/创建权限。
CreateEcKeyAsync(CreateEcKeyOptions, CancellationToken)

在 密钥保管库 中创建并存储新的椭圆曲线键。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 此操作需要密钥/创建权限。
CreateKey(String, KeyType, CreateKeyOptions, CancellationToken)

在 密钥保管库 中创建并存储新密钥。 创建密钥操作可用于在 Azure 密钥保管库中创建任何密钥类型。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 此操作需要密钥/创建权限。
CreateKeyAsync(String, KeyType, CreateKeyOptions, CancellationToken)

在 密钥保管库 中创建并存储新密钥。 创建密钥操作可用于在 Azure 密钥保管库中创建任何密钥类型。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 此操作需要密钥/创建权限。
CreateOctKey(CreateOctKeyOptions, CancellationToken)

在 密钥保管库 中创建并存储新的 AES 密钥。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 此操作需要密钥/创建权限。
CreateOctKeyAsync(CreateOctKeyOptions, CancellationToken)

在 密钥保管库 中创建并存储新的 AES 密钥。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 此操作需要密钥/创建权限。
CreateRsaKey(CreateRsaKeyOptions, CancellationToken)

在 密钥保管库 中创建并存储新的 RSA 密钥。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 此操作需要密钥/创建权限。
CreateRsaKeyAsync(CreateRsaKeyOptions, CancellationToken)

在 密钥保管库 中创建并存储新的 RSA 密钥。 如果命名的密钥已存在，Azure 密钥保管库将创建该密钥的新版本。 此操作需要密钥/创建权限。
GetCryptographyClient(String, String)

CryptographyClient获取给定密钥的 。
GetDeletedKey(String, CancellationToken)

获取已删除密钥的公共部分。
GetDeletedKeyAsync(String, CancellationToken)

获取已删除密钥的公共部分。
GetDeletedKeys(CancellationToken)

列出指定保管库中已删除的密钥。
GetDeletedKeysAsync(CancellationToken)

列出指定保管库中已删除的密钥。
GetKey(String, String, CancellationToken)

获取存储密钥的公共部分。
GetKeyAsync(String, String, CancellationToken)

获取存储密钥的公共部分。
GetKeyRotationPolicy(String, CancellationToken)

获取KeyRotationPolicy密钥保管库中指定键的 。
GetKeyRotationPolicyAsync(String, CancellationToken)

获取KeyRotationPolicy密钥保管库中指定键的 。
GetPropertiesOfKeys(CancellationToken)

列出指定保管库中所有已启用和禁用的密钥的属性。 可以在后续调用 中使用返回 Name 的 GetKey(String, String, CancellationToken)。
GetPropertiesOfKeysAsync(CancellationToken)

列出指定保管库中所有已启用和禁用的密钥的属性。 可以在后续调用 中使用返回 Name 的 GetKeyAsync(String, String, CancellationToken)。
GetPropertiesOfKeyVersions(String, CancellationToken)

列出指定密钥的所有启用和禁用版本的属性。 可以在后续调用 GetKey(String, String, CancellationToken)中使用返回的 Name 和 Version 。
GetPropertiesOfKeyVersionsAsync(String, CancellationToken)

列出指定密钥的所有启用和禁用版本的属性。 可以在后续调用 GetKeyAsync(String, String, CancellationToken)中使用返回的 Name 和 Version 。
GetRandomBytes(Int32, CancellationToken)

从托管硬件安全模块获取包含随机值的字节数， (HSM) 。
GetRandomBytesAsync(Int32, CancellationToken)

从托管硬件安全模块获取包含随机值的字节数， (HSM) 。
ImportKey(ImportKeyOptions, CancellationToken)

导入外部创建的密钥，存储它，然后将密钥参数和属性返回给客户端。
ImportKey(String, JsonWebKey, CancellationToken)

导入外部创建的密钥，存储它，然后将密钥参数和属性返回给客户端。
ImportKeyAsync(ImportKeyOptions, CancellationToken)

导入外部创建的密钥，存储它，然后将密钥参数和属性返回给客户端。
ImportKeyAsync(String, JsonWebKey, CancellationToken)

导入外部创建的密钥，存储它，然后将密钥参数和属性返回给客户端。
PurgeDeletedKey(String, CancellationToken)

永久删除指定的密钥。
PurgeDeletedKeyAsync(String, CancellationToken)

永久删除指定的密钥。
ReleaseKey(ReleaseKeyOptions, CancellationToken)

释放密钥。
ReleaseKey(String, String, CancellationToken)

释放密钥的最新版本。
ReleaseKeyAsync(ReleaseKeyOptions, CancellationToken)

释放密钥。
ReleaseKeyAsync(String, String, CancellationToken)

释放密钥的最新版本。
RestoreKeyBackup(Byte[], CancellationToken)

将备份的密钥还原到保管库。
RestoreKeyBackupAsync(Byte[], CancellationToken)

将备份的密钥还原到保管库。
RotateKey(String, CancellationToken)

在 密钥保管库 中创建新的密钥版本，存储它，然后返回新的 KeyVaultKey。
RotateKeyAsync(String, CancellationToken)

在 密钥保管库 中创建新的密钥版本，存储它，然后返回新的 KeyVaultKey。
StartDeleteKey(String, CancellationToken)

从 Azure 密钥保管库 中的存储中删除任何类型的密钥。
StartDeleteKeyAsync(String, CancellationToken)

从 Azure 密钥保管库 中的存储中删除任何类型的密钥。
StartRecoverDeletedKey(String, CancellationToken)

将已删除的密钥恢复到其最新版本。
StartRecoverDeletedKeyAsync(String, CancellationToken)

将已删除的密钥恢复到其最新版本。
UpdateKeyProperties(KeyProperties, IEnumerable<KeyOperation>, CancellationToken)

更新密钥操作会更改存储密钥的指定属性，并且可以应用于 Azure 密钥保管库中存储的任何密钥类型和密钥版本。
UpdateKeyPropertiesAsync(KeyProperties, IEnumerable<KeyOperation>, CancellationToken)

更新密钥操作会更改存储密钥的指定属性，并且可以应用于 Azure 密钥保管库中存储的任何密钥类型和密钥版本。
UpdateKeyRotationPolicy(String, KeyRotationPolicy, CancellationToken)

为 密钥保管库 中的指定键汇报 KeyRotationPolicy 。 轮换时，新策略将用于密钥的下一版本。
UpdateKeyRotationPolicyAsync(String, KeyRotationPolicy, CancellationToken)

为 密钥保管库 中的指定键汇报 KeyRotationPolicy 。 轮换时，新策略将用于密钥的下一版本。

适用于