CertificateClient.StartDeleteCertificateAsync Method

Definition

Namespace:

Azure.Security.KeyVault.Certificates

Assembly:

Azure.Security.KeyVault.Certificates.dll

Package:

Azure.Security.KeyVault.Certificates v4.7.0

Source:

CertificateClient.cs

Deletes all versions of the specified KeyVaultCertificate. If the vault is soft delete-enabled, the KeyVaultCertificate will be marked for permanent deletion and can be recovered with StartRecoverDeletedCertificate(String, CancellationToken), or purged with PurgeDeletedCertificate(String, CancellationToken). This operation requires the certificates/delete permission.

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Certificates.DeleteCertificateOperation> StartDeleteCertificateAsync (string certificateName, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteCertificateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Certificates.DeleteCertificateOperation>
override this.StartDeleteCertificateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Certificates.DeleteCertificateOperation>

Public Overridable Function StartDeleteCertificateAsync (certificateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeleteCertificateOperation)

Parameters

certificateName

String

The name of the KeyVaultCertificate to delete.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<DeleteCertificateOperation>

A DeleteCertificateOperation to wait on this long-running operation. If the Key Vault is soft delete-enabled, you only need to wait for the operation to complete if you need to recover or purge the certificate; otherwise, the certificate is deleted automatically on the ScheduledPurgeDate.

Exceptions

ArgumentException

certificateName is empty.

ArgumentNullException

certificateName is null.