SecretClient.StartRecoverDeletedSecret(String, CancellationToken) Method

Definition

Recovers the deleted secret to the latest version.

public virtual Azure.Security.KeyVault.Secrets.RecoverDeletedSecretOperation StartRecoverDeletedSecret (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member StartRecoverDeletedSecret : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Secrets.RecoverDeletedSecretOperation
override this.StartRecoverDeletedSecret : string * System.Threading.CancellationToken -> Azure.Security.KeyVault.Secrets.RecoverDeletedSecretOperation
Public Overridable Function StartRecoverDeletedSecret (name As String, Optional cancellationToken As CancellationToken = Nothing) As RecoverDeletedSecretOperation

Parameters

name
String

The name of the secret.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

RecoverDeletedSecretOperation

A RecoverDeletedSecretOperation to wait on this long-running operation.

Exceptions

name is an empty string.

name is null.

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

Remarks

Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.

Applies to