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

KeyClient.StartDeleteKey(String, CancellationToken) 方法

定义

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

public virtual Azure.Security.KeyVault.Keys.DeleteKeyOperation StartDeleteKey (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member StartDeleteKey : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.DeleteKeyOperation
override this.StartDeleteKey : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.DeleteKeyOperation
Public Overridable Function StartDeleteKey (name As String, Optional cancellationToken As CancellationToken = Nothing) As DeleteKeyOperation

参数

name
String

键的名称。

cancellationToken
CancellationToken

控制 CancellationToken 请求生存期的 。

返回

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

例外

name 是一个空字符串。

name 为 null。

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

注解

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

适用于