SecretClient.PurgeDeletedSecret(String, CancellationToken) Method
Definition
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 Azure.Response PurgeDeletedSecret(string name, System.Threading.CancellationToken cancellationToken = default);abstract member PurgeDeletedSecret : string * System.Threading.CancellationToken -> Azure.Response
override this.PurgeDeletedSecret : string * System.Threading.CancellationToken -> Azure.ResponsePublic Overridable Function PurgeDeletedSecret (name As String, Optional cancellationToken As CancellationToken = Nothing) As ResponseParameters
- 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 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.
