CertificateClient.PurgeDeletedCertificateAsync Method

Definition

Permanently and irreversibly deletes the specified deleted certificate, without the possibility of recovery. This operation is only applicable in vaults enabled for soft delete, and requires the certificates/purge permission. The operation is not available if the DeletedCertificate.RecoveryLevel of the DeletedCertificate does not specify 'Purgeable'.

public virtual System.Threading.Tasks.Task<Azure.Response> PurgeDeletedCertificateAsync (string certificateName, System.Threading.CancellationToken cancellationToken = default);
abstract member PurgeDeletedCertificateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.PurgeDeletedCertificateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function PurgeDeletedCertificateAsync (certificateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

certificateName
String

The name of the DeletedCertificate to permanently delete.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<Response>

The HTTP response from the service.

Exceptions

certificateName is empty.

certificateName is null.

Applies to