KeyClient.StartDeleteKeyAsync(String, CancellationToken) Méthode

Définition

Supprime une clé de tout type du stockage dans Azure Key Vault.

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation> StartDeleteKeyAsync (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member StartDeleteKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation>
override this.StartDeleteKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Keys.DeleteKeyOperation>
Public Overridable Function StartDeleteKeyAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DeleteKeyOperation)

Paramètres

name
String

Nom de la clé.

cancellationToken
CancellationToken

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

Retours

DeleteKeyOperation 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 la clé ; sinon, la clé est supprimée 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 de clé ne peut pas être utilisée pour supprimer des versions individuelles d’une clé. Cette opération supprime le matériel de chiffrement associé à la clé, ce qui signifie que la clé n'est pas utilisable pour des opérations Sign/Verify, Wrap/Unwrap ou Encrypt/Decrypt. Cette opération nécessite l’autorisation keys/delete.

S’applique à