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

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

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

Applies to

Dela via