Share via


KeyClient.PurgeDeletedKey(String, CancellationToken) Method

Definition

Permanently deletes the specified key.

public virtual Azure.Response PurgeDeletedKey (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member PurgeDeletedKey : string * System.Threading.CancellationToken -> Azure.Response
override this.PurgeDeletedKey : string * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function PurgeDeletedKey (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

name
String

The name of the key.

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 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