IKeyVaultClient.PurgeDeletedSecretWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.KeyVault

Assembly:: Microsoft.Azure.KeyVault.dll

Package:: Microsoft.Azure.KeyVault v3.0.5

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 System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> PurgeDeletedSecretWithHttpMessagesAsync (string vaultBaseUrl, string secretName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PurgeDeletedSecretWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>

Public Function PurgeDeletedSecretWithHttpMessagesAsync (vaultBaseUrl As String, secretName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

vaultBaseUrl: String

The vault name, for example https://myvault.vault.azure.net.

secretName: String

The name of the secret.

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

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

Dela via