Share via


SecretClient.GetDeletedSecretAsync(String, CancellationToken) Method

Definition

Gets the specified deleted secret.

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

Parameters

name
String

The name of the secret.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Exceptions

name is an empty string.

name is null.

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

Remarks

The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.

Applies to