KeyVaultClient.RecoverDeletedKeyWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Package:

Microsoft.Azure.KeyVault v3.0.5

Source:

KeyVaultClient.cs

Recovers the deleted key to its latest version.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyBundle>> RecoverDeletedKeyWithHttpMessagesAsync (string vaultBaseUrl, string keyName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member RecoverDeletedKeyWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyBundle>>
override this.RecoverDeletedKeyWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.KeyBundle>>

Public Function RecoverDeletedKeyWithHttpMessagesAsync (vaultBaseUrl As String, keyName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of KeyBundle))

Parameters

vaultBaseUrl

String

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

keyName

String

The name of the deleted key.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<KeyBundle>>

Implements

RecoverDeletedKeyWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken)

Exceptions

KeyVaultErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null

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.