KeyVaultClientExtensions.PurgeDeletedCertificateAsync Method

Definition

Overloads

PurgeDeletedCertificateAsync(IKeyVaultClient, String, String, CancellationToken)

Permanently deletes the specified deleted certificate.

PurgeDeletedCertificateAsync(IKeyVaultClient, String, CancellationToken)

Purges the deleted certificate with immediate effect.

PurgeDeletedCertificateAsync(IKeyVaultClient, String, String, CancellationToken)

Permanently deletes the specified deleted certificate.

public static System.Threading.Tasks.Task PurgeDeletedCertificateAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string certificateName, System.Threading.CancellationToken cancellationToken = default);
static member PurgeDeletedCertificateAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function PurgeDeletedCertificateAsync (operations As IKeyVaultClient, vaultBaseUrl As String, certificateName 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.

certificateName
String

The name of the certificate

cancellationToken
CancellationToken

The cancellation token.

Returns

Task

Remarks

The PurgeDeletedCertificate operation performs an irreversible deletion of

the specified certificate, without possibility for recovery. The operation

is not available if the recovery level does not specify 'Purgeable'. This

operation requires the certificate/purge permission.

PurgeDeletedCertificateAsync(IKeyVaultClient, String, CancellationToken)

Purges the deleted certificate with immediate effect.

public static System.Threading.Tasks.Task PurgeDeletedCertificateAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string recoveryId, System.Threading.CancellationToken cancellationToken = default);
static member PurgeDeletedCertificateAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function PurgeDeletedCertificateAsync (operations As IKeyVaultClient, recoveryId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

operations
IKeyVaultClient
recoveryId
String

The recoveryId of the deleted certificate, returned from deletion.

cancellationToken
CancellationToken

Optional cancellation token

Returns

Task

Task representing the asynchronous execution of this request.

Applies to