CertificateClient.StartDeleteCertificate(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Certificates

Assembly:: Azure.Security.KeyVault.Certificates.dll

Package:: Azure.Security.KeyVault.Certificates v4.6.0

Package:: Azure.Security.KeyVault.Certificates v4.6.0-beta.2

Source:: CertificateClient.cs

Source:: CertificateClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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 Azure.Security.KeyVault.Certificates.DeleteCertificateOperation StartDeleteCertificate (string certificateName, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteCertificate : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Certificates.DeleteCertificateOperation
override this.StartDeleteCertificate : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Certificates.DeleteCertificateOperation

Public Overridable Function StartDeleteCertificate (certificateName As String, Optional cancellationToken As CancellationToken = Nothing) As DeleteCertificateOperation

Parameters

certificateName: String

The name of the KeyVaultCertificate to delete.

cancellationToken: CancellationToken

A CancellationToken controlling the request lifetime.

Returns

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.

Applies to