Share via


KeyVaultClientExtensions.GetDeletedKeysAsync Method

Definition

Lists the deleted keys in the specified vault.

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedKeyItem>> GetDeletedKeysAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, int? maxresults = default, System.Threading.CancellationToken cancellationToken = default);
static member GetDeletedKeysAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedKeyItem>>
<Extension()>
Public Function GetDeletedKeysAsync (operations As IKeyVaultClient, vaultBaseUrl As String, Optional maxresults As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of DeletedKeyItem))

Parameters

operations
IKeyVaultClient

The operations group for this extension method.

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.

cancellationToken
CancellationToken

The cancellation token.

Returns

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