KeyClient.StartRecoverDeletedKey(String, 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.

Recovers the deleted key to its latest version.

public virtual Azure.Security.KeyVault.Keys.RecoverDeletedKeyOperation StartRecoverDeletedKey (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartRecoverDeletedKey : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.RecoverDeletedKeyOperation
override this.StartRecoverDeletedKey : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Keys.RecoverDeletedKeyOperation

Public Overridable Function StartRecoverDeletedKey (name As String, Optional cancellationToken As CancellationToken = Nothing) As RecoverDeletedKeyOperation

Parameters

name: String

The name of the key.

cancellationToken: CancellationToken

A CancellationToken controlling the request lifetime.

Returns

RecoverDeletedKeyOperation

A RecoverDeletedKeyOperation to wait on this long-running operation.

Exceptions

ArgumentException

name is an empty string.

ArgumentNullException

name is null.

RequestFailedException

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

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.

Applies to