KeyClient.StartDeleteKey(String, CancellationToken) Méthode

Définition

Supprime une clé de n’importe quel type de stockage dans Azure Key Vault.

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

Paramètres

name
String

Nom de la clé.

cancellationToken
CancellationToken

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

Retours

pour DeleteKeyOperation attendre cette opération de longue durée. Si le Key Vault est activé pour la suppression réversible, il vous suffit d’attendre que l’opération se termine si vous devez récupérer ou vider la clé ; sinon, la clé est supprimée automatiquement sur .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 retournées à partir du 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 à