KeyVaultClientExtensions.DeleteSecretAsync(IKeyVaultClient, String, String, CancellationToken) Method

Definition

Deletes a secret from a specified key vault.

public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.DeletedSecretBundle> DeleteSecretAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string secretName, System.Threading.CancellationToken cancellationToken = null);
static member DeleteSecretAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.DeletedSecretBundle>

Parameters

operations
IKeyVaultClient

The operations group for this extension method.

vaultBaseUrl
String

The vault name, for example https://myvault.vault.azure.net.

secretName
String

The name of the secret.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<DeletedSecretBundle>

Remarks

The DELETE operation applies to any secret stored in Azure Key Vault.

DELETE cannot be applied to an individual version of a secret.

Applies to