KeyVaultClientExtensions.PurgeDeletedKeyAsync 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.
Overloads
| PurgeDeletedKeyAsync(IKeyVaultClient, String, CancellationToken) |
Purges the deleted key immediately. |
| PurgeDeletedKeyAsync(IKeyVaultClient, String, String, CancellationToken) |
Permanently deletes the specified key. |
PurgeDeletedKeyAsync(IKeyVaultClient, String, CancellationToken)
- Source:
- KeyVaultClientExtensions.cs
Purges the deleted key immediately.
public static System.Threading.Tasks.Task PurgeDeletedKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string recoveryId, System.Threading.CancellationToken cancellationToken = default);static member PurgeDeletedKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Extension()>
Public Function PurgeDeletedKeyAsync (operations As IKeyVaultClient, recoveryId As String, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- operations
- IKeyVaultClient
- recoveryId
- String
The recoveryId of the deleted key, returned from deletion.
- cancellationToken
- CancellationToken
Optional cancellation token
Returns
Task representing the asynchronous execution of this request.
Applies to
PurgeDeletedKeyAsync(IKeyVaultClient, String, String, CancellationToken)
- Source:
- KeyVaultClientExtensions.cs
Permanently deletes the specified key.
public static System.Threading.Tasks.Task PurgeDeletedKeyAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, string keyName, System.Threading.CancellationToken cancellationToken = default);static member PurgeDeletedKeyAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Extension()>
Public Function PurgeDeletedKeyAsync (operations As IKeyVaultClient, vaultBaseUrl As String, keyName As String, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- operations
- IKeyVaultClient
The operations group for this extension method.
- vaultBaseUrl
- String
The vault name, for example https://myvault.vault.azure.net.
- keyName
- String
The name of the key
- cancellationToken
- CancellationToken
The cancellation token.
Returns
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.
