SecretClient.GetDeletedSecret(String, CancellationToken) Method

Definition

Namespace:

Azure.Security.KeyVault.Secrets

Assembly:

Azure.Security.KeyVault.Secrets.dll

Package:

Azure.Security.KeyVault.Secrets v4.7.0

Source:

SecretClient.cs

Gets the specified deleted secret.

public virtual Azure.Response<Azure.Security.KeyVault.Secrets.DeletedSecret> GetDeletedSecret (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDeletedSecret : string * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Secrets.DeletedSecret>
override this.GetDeletedSecret : string * System.Threading.CancellationToken -> Azure.Response<Azure.Security.KeyVault.Secrets.DeletedSecret>

Public Overridable Function GetDeletedSecret (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DeletedSecret)

Parameters

name

String

The name of the secret.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Response<DeletedSecret>

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 Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.