SecretClient.PurgeDeletedSecretAsync(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.

Permanently deletes the specified secret.

public virtual System.Threading.Tasks.Task<Azure.Response> PurgeDeletedSecretAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member PurgeDeletedSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.PurgeDeletedSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

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

Parameters

name: String

The name of the secret.

cancellationToken: CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<Response>

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 purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.

Applies to