KeyClient.GetDeletedKeys(CancellationToken) Method

Definition

Lists the deleted keys in the specified vault.

public virtual Azure.Pageable<Azure.Security.KeyVault.Keys.DeletedKey> GetDeletedKeys (System.Threading.CancellationToken cancellationToken = default);
abstract member GetDeletedKeys : System.Threading.CancellationToken -> Azure.Pageable<Azure.Security.KeyVault.Keys.DeletedKey>
override this.GetDeletedKeys : System.Threading.CancellationToken -> Azure.Pageable<Azure.Security.KeyVault.Keys.DeletedKey>
Public Overridable Function GetDeletedKeys (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DeletedKey)

Parameters

cancellationToken
System.Threading.CancellationToken

A System.Threading.CancellationToken controlling the request lifetime.

Returns

Pageable<DeletedKey>

Exceptions

The server returned an error. See System.Exception.Message for details returned from the server.

Remarks

Retrieves a list of the keys in the Key Vault that contains 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