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

KeyClient.PurgeDeletedKeyAsync(String, CancellationToken) 方法

定义

命名空间:

Azure.Security.KeyVault.Keys

程序集:

Azure.Security.KeyVault.Keys.dll

包:

Azure.Security.KeyVault.Keys v4.6.0

Source:

KeyClient.cs

永久删除指定的密钥。

public virtual System.Threading.Tasks.Task<Azure.Response> PurgeDeletedKeyAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member PurgeDeletedKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.PurgeDeletedKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

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

参数

name

String

键的名称。

cancellationToken

CancellationToken

控制 CancellationToken 请求生存期的 。

返回

Task<Response>

例外

ArgumentException

name 是一个空字符串。

ArgumentNullException

name 为 null。

RequestFailedException

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

注解

清除已删除的密钥操作适用于已启用软删除的保管库。 虽然可以在任何保管库上调用该操作，但如果在启用了非软删除的保管库上调用，它将返回错误。 此操作需要密钥/清除权限。