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

Definition

Deletes a key of any type from storage in Azure Key Vault.

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

Parameters

operations
IKeyVaultClient

The operations group for this extension method.

vaultBaseUrl
String

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

keyName
String

The name of the key to delete.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<DeletedKeyBundle>

Remarks

The delete key operation cannot be used to remove individual versions of a

key. This operation removes the cryptographic material associated with the

key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or

Encrypt/Decrypt operations.

Applies to