SecretClient.StartRecoverDeletedSecretAsync(String, CancellationToken) Method

Definition

Recovers the deleted secret to the latest version.

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

Parameters

name
String

The name of the secret.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<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