KeyClient.PurgeDeletedKeyAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Security.KeyVault.Keys

Assembly:: Azure.Security.KeyVault.Keys.dll

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

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

Source:: KeyClient.cs

Source:: KeyClient.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 key.

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

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

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

Parameters

name: String

The name of the key.

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 Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/purge permission.

Applies to