KeyVaultClient.GetDeletedKeysWithHttpMessagesAsync(String, Nullable<Int32>, Dictionary<String,List<String>>, CancellationToken) Method

Definition

Lists the deleted keys in the specified vault.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedKeyItem>>> GetDeletedKeysWithHttpMessagesAsync (string vaultBaseUrl, int? maxresults = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDeletedKeysWithHttpMessagesAsync : string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedKeyItem>>>
override this.GetDeletedKeysWithHttpMessagesAsync : string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedKeyItem>>>
Public Function GetDeletedKeysWithHttpMessagesAsync (vaultBaseUrl As String, Optional maxresults As Nullable(Of Integer) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of DeletedKeyItem)))

Parameters

vaultBaseUrl
String

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

maxresults
Nullable<Int32>

Maximum number of results to return in a page. If not specified the service will return up to 25 results.

customHeaders
Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<DeletedKeyItem>>>

Implements

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Thrown when a required parameter is null

Remarks

Retrieves a list of the keys in the Key Vault as JSON Web Key structures

that contain the public part of a deleted key. This operation includes

deletion-specific information. The Get Deleted Keys operation is applicable

for vaults enabled for soft-delete. 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/list permission.

Applies to