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

KeyClient.StartDeleteKeyAsync(String, CancellationToken) 方法

定义

命名空间:

Azure.Security.KeyVault.Keys

程序集:

Azure.Security.KeyVault.Keys.dll

包:

Azure.Security.KeyVault.Keys v4.6.0

Source:

KeyClient.cs

从 Azure 密钥保管库 中的存储中删除任何类型的密钥。

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation> StartDeleteKeyAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation>
override this.StartDeleteKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation>

Public Overridable Function StartDeleteKeyAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeleteKeyOperation)

参数

name

String

键的名称。

cancellationToken

CancellationToken

控制 CancellationToken 请求生存期的 。

返回

Task<DeleteKeyOperation>

等待 DeleteKeyOperation 此长时间运行的操作的 。 如果密钥保管库启用了软删除，则只需在需要恢复或清除密钥时等待操作完成;否则，会在 上ScheduledPurgeDate自动删除该密钥。

例外

ArgumentException

name 是一个空字符串。

ArgumentNullException

name 为 null。

RequestFailedException

服务器返回了错误。 有关从服务器返回的详细信息，请参阅 Message 。

注解

删除密钥操作不能用于删除单个版本的密钥。 此操作将删除与密钥关联的加密材料，也就是说，该密钥不可用于签名/验证、包装/解包或加密/解密操作。 此操作需要密钥/删除权限。