KeyVaultClient.PurgeDeletedKeyWithHttpMessagesAsync Método

Definição

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Pacote:

Microsoft.Azure.KeyVault v3.0.5

Origem:

KeyVaultClient.cs

Exclui permanentemente a chave especificada.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> PurgeDeletedKeyWithHttpMessagesAsync (string vaultBaseUrl, string keyName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PurgeDeletedKeyWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
override this.PurgeDeletedKeyWithHttpMessagesAsync : 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 PurgeDeletedKeyWithHttpMessagesAsync (vaultBaseUrl As String, keyName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parâmetros

vaultBaseUrl

String

O nome do cofre, por exemplo https://myvault.vault.azure.net, .

keyName

String

O nome da chave

customHeaders

Dictionary<String,List<String>>

Cabeçalhos que serão adicionados à solicitação.

cancellationToken

CancellationToken

O token de cancelamento.

Retornos

Task<AzureOperationResponse>

Implementações

PurgeDeletedKeyWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken)

Exceções

KeyVaultErrorException

Gerada quando a operação retornou um código de status inválido

ValidationException

Gerado quando um parâmetro necessário é nulo

ArgumentNullException

Gerado quando um parâmetro necessário é nulo

Comentários

A operação Limpar Chave Excluída é aplicável a cofres habilitados para exclusão reversível. Embora a operação possa ser invocada em qualquer cofre, ela retornará um erro se invocada em um cofre não habilitado para exclusão reversível. Essa operação requer a permissão de limpeza/chaves.