KeyVaultClientExtensions.DeleteSecretAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.KeyVault

Assembly:: Microsoft.Azure.KeyVault.dll

Package:: Microsoft.Azure.KeyVault v3.0.5

Source:: KeyVaultClientExtensions.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 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 = default);

static member DeleteSecretAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.DeletedSecretBundle>

<Extension()>
Public Function DeleteSecretAsync (operations As IKeyVaultClient, vaultBaseUrl As String, secretName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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. This operation requires the secrets/delete permission.

Applies to