SecretClient.StartDeleteSecretAsync(String, CancellationToken) Méthode

Définition

Supprime un secret d’un coffre de clés spécifié.

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)

Paramètres

name
String

Nom du secret.

cancellationToken
CancellationToken

Contrôle CancellationToken de la durée de vie de la requête.

Retours

DeleteSecretOperation pour attendre cette opération de longue durée. Si le Key Vault est activé pour la suppression réversible, il vous suffit d’attendre la fin de l’opération si vous devez récupérer ou vider le secret ; sinon, le secret est supprimé automatiquement sur le ScheduledPurgeDate.

Exceptions

name est une chaîne vide.

name a la valeur null.

Le serveur a retourné une erreur. Consultez Message pour plus d’informations renvoyées par le serveur.

Remarques

L’opération de suppression s’applique à tout secret stocké dans Azure Key Vault. La suppression ne peut pas être appliquée à une version individuelle d’un secret. Cette opération nécessite l’autorisation secrets/suppression.

S’applique à