SecretClient.StartDeleteSecretAsync(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 um segredo de um cofre de chaves especificado.

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation> StartDeleteSecretAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation>
override this.StartDeleteSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation>

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

Parâmetros

name

String

O nome do segredo.

cancellationToken

CancellationToken

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

Retornos

Task<DeleteSecretOperation>

Um DeleteSecretOperation 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 o segredo; caso contrário, o segredo será excluído 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 de exclusão se aplica a qualquer segredo armazenado no Azure Key Vault. A exclusão não pode ser aplicada a uma versão individual de um segredo. Essa operação requer a permissão de segredos/exclusão.