KeyVaultClient.DeleteKeyWithHttpMessagesAsync Método

Definição

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Pacote:

Microsoft.Azure.KeyVault v3.0.5

Origem:

KeyVaultClient.cs

Exclui uma chave de qualquer tipo do armazenamento no Azure Key Vault.

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

abstract member DeleteKeyWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.DeletedKeyBundle>>
override this.DeleteKeyWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.DeletedKeyBundle>>

Public Function DeleteKeyWithHttpMessagesAsync (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(Of DeletedKeyBundle))

Parâmetros

vaultBaseUrl

String

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

keyName

String

O nome da chave a ser excluída.

customHeaders

Dictionary<String,List<String>>

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

cancellationToken

CancellationToken

O token de cancelamento.

Retornos

Task<AzureOperationResponse<DeletedKeyBundle>>

Implementações

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

Exceções

KeyVaultErrorException

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

SerializationException

Gerada quando não é possível desserializar a resposta

ValidationException

Gerado quando um parâmetro necessário é nulo

ArgumentNullException

Gerado quando um parâmetro necessário é nulo

Comentários

A operação de exclusão de chave não pode ser usada para remover versões individuais de uma chave. Essa operação remove o material criptográfico associado à chave, o que significa que a chave não pode ser usada para operações Sign/Verify, Wrap/Unwrap ou Encrypt/Decrypt. Essa operação requer a permissão de exclusão/chaves.