KeyVaultClientExtensions.PurgeDeletedKeyAsync Method

Definition

Overloads

PurgeDeletedKeyAsync(IKeyVaultClient, String, CancellationToken)

Purges the deleted key immediately.

PurgeDeletedKeyAsync(IKeyVaultClient, String, String, CancellationToken)

Permanently deletes the specified key. aka purges the key. Authorization: Requires the keys/purge permission.

PurgeDeletedKeyAsync(IKeyVaultClient, String, CancellationToken)

Purges the deleted key immediately.

public static System.Threading.Tasks.Task PurgeDeletedKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string recoveryId, System.Threading.CancellationToken cancellationToken = null);
static member PurgeDeletedKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

operations
IKeyVaultClient
recoveryId
String

The recoveryId of the deleted key, returned from deletion.

cancellationToken
CancellationToken

Optional cancellation token

Returns

Task

Task representing the asynchronous execution of this request.

Applies to

Product Introduced

PurgeDeletedKeyAsync(IKeyVaultClient, String, String, CancellationToken)

Permanently deletes the specified key. aka purges the key. Authorization: Requires the keys/purge permission.

public static System.Threading.Tasks.Task PurgeDeletedKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string keyName, System.Threading.CancellationToken cancellationToken = null);
static member PurgeDeletedKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Parameters

operations
IKeyVaultClient

The operations group for this extension method.

vaultBaseUrl
String

The vault name, for example https://myvault.vault.azure.net.

keyName
String

The name of the key

cancellationToken
CancellationToken

The cancellation token.

Returns

Task

Applies to

Product Introduced