KeyClient.StartDeleteKeyAsync(String, CancellationToken) Método

Definição

Namespace:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Pacote:

Azure.Security.KeyVault.Keys v4.6.0

Origem:

KeyClient.cs

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

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation> StartDeleteKeyAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation>
override this.StartDeleteKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation>

Public Overridable Function StartDeleteKeyAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeleteKeyOperation)

Parâmetros

name

String

O nome da chave.

cancellationToken

CancellationToken

Um CancellationToken que controla o tempo de vida da solicitação.

Retornos

Task<DeleteKeyOperation>

Um DeleteKeyOperation para aguardar essa operação de longa execução. Se o Key Vault estiver habilitado para exclusão temporária, você só precisará aguardar a conclusão da operação se precisar recuperar ou limpar a chave; caso contrário, a chave será excluída automaticamente no ScheduledPurgeDate.

Exceções

ArgumentException

name é uma cadeia de caracteres vazia.

ArgumentNullException

name é nulo.

RequestFailedException

O servidor retornou um erro. Consulte Message para obter detalhes retornados do servidor.

Comentários

A operação excluir 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.