KeyClient.PurgeDeletedKey(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 permanentemente a chave especificada.

public virtual Azure.Response PurgeDeletedKey (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member PurgeDeletedKey : string * System.Threading.CancellationToken -> Azure.Response
override this.PurgeDeletedKey : string * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function PurgeDeletedKey (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response

Parâmetros

name

String

O nome da chave.

cancellationToken

CancellationToken

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

Retornos

Response

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 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 for invocada em um cofre não habilitado para exclusão reversível. Essa operação requer a permissão de limpeza/chaves.