KeyClient.GetDeletedKeys(CancellationToken) Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Keys

Assembly:: Azure.Security.KeyVault.Keys.dll

Package:: Azure.Security.KeyVault.Keys v4.6.0

Package:: Azure.Security.KeyVault.Keys v4.6.0-beta.2

Source:: KeyClient.cs

Source:: KeyClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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: CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Pageable<DeletedKey>

Exceptions

RequestFailedException

The server returned an error. See 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