SecretClient.PurgeDeletedSecretAsync(String, CancellationToken) Método

Definição

Namespace:

Azure.Security.KeyVault.Secrets

Assembly:

Azure.Security.KeyVault.Secrets.dll

Pacote:

Azure.Security.KeyVault.Secrets v4.6.0

Origem:

SecretClient.cs

Exclui permanentemente o segredo especificado.

public virtual System.Threading.Tasks.Task<Azure.Response> PurgeDeletedSecretAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member PurgeDeletedSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.PurgeDeletedSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

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

Parâmetros

name

String

O nome do segredo.

cancellationToken

CancellationToken

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

Retornos

Task<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 secreta de limpeza excluída remove o segredo permanentemente, sem a possibilidade de recuperação. Essa operação só pode ser habilitada em um cofre habilitado para exclusão reversível. Essa operação requer a permissão de segredos/limpeza.