KeyVaultClientExtensions.PurgeDeletedSecretAsync Method

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Package:

Microsoft.Azure.KeyVault v3.0.5

Overloads

PurgeDeletedSecretAsync(IKeyVaultClient, String, CancellationToken)	Purges the deleted secret immediately.
PurgeDeletedSecretAsync(IKeyVaultClient, String, String, CancellationToken)	Permanently deletes the specified secret.

PurgeDeletedSecretAsync(IKeyVaultClient, String, CancellationToken)

Source:

KeyVaultClientExtensions.cs

Purges the deleted secret immediately.

public static System.Threading.Tasks.Task PurgeDeletedSecretAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string recoveryId, System.Threading.CancellationToken cancellationToken = default);

static member PurgeDeletedSecretAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function PurgeDeletedSecretAsync (operations As IKeyVaultClient, recoveryId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations

IKeyVaultClient

recoveryId

String

The recoveryId of the deleted secret, returned from deletion.

cancellationToken

CancellationToken

Optional cancellation token

Returns

Task

Task representing the asynchronous execution of this request.

PurgeDeletedSecretAsync(IKeyVaultClient, String, String, CancellationToken)

Source:

KeyVaultClientExtensions.cs

Permanently deletes the specified secret.

public static System.Threading.Tasks.Task PurgeDeletedSecretAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string secretName, System.Threading.CancellationToken cancellationToken = default);

static member PurgeDeletedSecretAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function PurgeDeletedSecretAsync (operations As IKeyVaultClient, vaultBaseUrl As String, secretName As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations

IKeyVaultClient

The operations group for this extension method.

vaultBaseUrl

String

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

secretName

String

The name of the secret.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task

Remarks

The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.