SecretClient.StartDeleteSecret(String, CancellationToken) Method

Definition

Deletes a secret from a specified key vault.

public virtual Azure.Security.KeyVault.Secrets.DeleteSecretOperation StartDeleteSecret (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member StartDeleteSecret : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Secrets.DeleteSecretOperation
override this.StartDeleteSecret : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Secrets.DeleteSecretOperation
Public Overridable Function StartDeleteSecret (name As String, Optional cancellationToken As CancellationToken = Nothing) As DeleteSecretOperation

Parameters

name
System.String

The name of the secret.

cancellationToken
System.Threading.CancellationToken

A System.Threading.CancellationToken controlling the request lifetime.

Returns

DeleteSecretOperation

A DeleteSecretOperation 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 secret; otherwise, the secret is deleted automatically on the ScheduledPurgeDate.

Exceptions

System.ArgumentException

name is an empty string.

System.ArgumentNullException

name is null.

The server returned an error. See System.Exception.Message for details returned from the server.

Remarks

The delete operation applies to any secret stored in Azure Key Vault. Delete cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.

Applies to