Freigeben über


KeyClient.StartDeleteKey(String, CancellationToken) Methode

Definition

Löscht einen Schlüssel eines beliebigen Typs aus dem Speicher in 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

Parameter

name
String

Der Name des Schlüssels.

cancellationToken
CancellationToken

Ein CancellationToken , der die Anforderungsdauer steuert.

Gibt zurück

Ein DeleteKeyOperation , um auf diesen lang andauernden Vorgang zu warten. Wenn der Key Vault vorläufiges Löschen aktiviert ist, müssen Sie nur warten, bis der Vorgang abgeschlossen ist, wenn Sie den Schlüssel wiederherstellen oder bereinigen müssen. Andernfalls wird der Schlüssel automatisch für ScheduledPurgeDategelöscht.

Ausnahmen

name ist eine leere Zeichenfolge.

name ist NULL.

Der Server hat einen Fehler zurückgegeben. Details, die vom Server zurückgegeben werden, finden Sie Message unter.

Hinweise

Der Vorgang zum Löschen des Schlüssels kann nicht verwendet werden, um einzelne Versionen eines Schlüssels zu entfernen. Dieser Vorgang entfernt das kryptografische Material, das dem Schlüssel zugeordnet ist, was bedeutet, dass der Schlüssel nicht für Sign/Verify-, Wrap/Unwrap- oder Encrypt/Decrypt-Vorgänge verwendet werden kann. Für diesen Vorgang wird die Berechtigung „keys/delete“ benötigt.

Gilt für: