SecretClient.StartRecoverDeletedSecretAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Secrets

Assembly:: Azure.Security.KeyVault.Secrets.dll

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

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

Source:: SecretClient.cs

Source:: SecretClient.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 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

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

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