KeyClient.StartRecoverDeletedKeyAsync(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

Recupera a chave excluída para sua versão mais recente.

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

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

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

Parâmetros

name

String

O nome da chave.

cancellationToken

CancellationToken

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

Retornos

Task<RecoverDeletedKeyOperation>

Um RecoverDeletedKeyOperation para aguardar essa operação de longa execução.

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 Recuperar Chave Excluída é aplicável a chaves excluídas em cofres habilitados para exclusão reversível. Ele recupera a chave excluída de volta para sua versão mais recente em /keys. Uma tentativa de recuperar uma chave não excluída retornará um erro. Considere isso o inverso da operação de exclusão em cofres habilitados para exclusão reversível. Essa operação requer a permissão de recuperação/chaves.