KeyVaultClientExtensions.GetDeletedKeyAsync 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.

Gets the public part of a deleted key.

public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.DeletedKeyBundle> GetDeletedKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string keyName, System.Threading.CancellationToken cancellationToken = default);

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

<Extension()>
Public Function GetDeletedKeyAsync (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.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<DeletedKeyBundle>

Remarks

The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/get permission.

Applies to