KeyVaultClientExtensions.RecoverDeletedKeyAsync Method

Definition

Overloads

RecoverDeletedKeyAsync(IKeyVaultClient, String, CancellationToken)

Recovers the deleted key.

RecoverDeletedKeyAsync(IKeyVaultClient, String, String, CancellationToken)

Recovers the deleted key to its latest version.

RecoverDeletedKeyAsync(IKeyVaultClient, String, CancellationToken)

Recovers the deleted key.

public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyBundle> RecoverDeletedKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string recoveryId, System.Threading.CancellationToken cancellationToken = default);
static member RecoverDeletedKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyBundle>
<Extension()>
Public Function RecoverDeletedKeyAsync (operations As IKeyVaultClient, recoveryId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of KeyBundle)

Parameters

operations
IKeyVaultClient
recoveryId
String

The recoveryId of the deleted key, returned from deletion.

cancellationToken
CancellationToken

Optional cancellation token

Returns

Task<KeyBundle>

A response message containing the recovered key

RecoverDeletedKeyAsync(IKeyVaultClient, String, String, CancellationToken)

Recovers the deleted key to its latest version.

public static System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyBundle> RecoverDeletedKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string keyName, System.Threading.CancellationToken cancellationToken = default);
static member RecoverDeletedKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.KeyVault.Models.KeyBundle>
<Extension()>
Public Function RecoverDeletedKeyAsync (operations As IKeyVaultClient, vaultBaseUrl As String, keyName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of KeyBundle)

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 deleted key.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<KeyBundle>

Remarks

The Recover Deleted Key operation is applicable for deleted keys in

soft-delete enabled vaults. It recovers the deleted key back to its latest

version under /keys. An attempt to recover an non-deleted key will return

an error. Consider this the inverse of the delete operation on soft-delete

enabled vaults. This operation requires the keys/recover permission.

Applies to