KeyClient.PurgeDeletedKeyAsync(String, CancellationToken) Méthode

Définition

Espace de noms:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Paquet:

Azure.Security.KeyVault.Keys v4.6.0

Source:

KeyClient.cs

Supprime définitivement la clé spécifiée.

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

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

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

Paramètres

name

String

Nom de la clé.

cancellationToken

CancellationToken

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

Retours

Task<Response>

Exceptions

ArgumentException

name est une chaîne vide.

ArgumentNullException

name a la valeur null.

RequestFailedException

Le serveur a retourné une erreur. Consultez Message pour plus d’informations retournées à partir du serveur.

Remarques

L’opération Purger la clé supprimée s’applique aux coffres avec suppression réversible. Bien que l’opération puisse être appelée sur n’importe quel coffre, elle retourne une erreur si elle est appelée sur un coffre non activé par suppression réversible. Cette opération nécessite l’autorisation clés/purge.