SecretClient.StartDeleteSecretAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.Security.KeyVault.Secrets

Assembly:

Azure.Security.KeyVault.Secrets.dll

Package:

Azure.Security.KeyVault.Secrets v4.7.0

Source:

SecretClient.cs

Deletes a secret from a specified key vault.

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation> StartDeleteSecretAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation>
override this.StartDeleteSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation>

Public Overridable Function StartDeleteSecretAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeleteSecretOperation)

Parameters

name

String

The name of the secret.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<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

ArgumentException

name is an empty string.

ArgumentNullException

name is null.

RequestFailedException

The server returned an error. See 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.