KeyClient.StartDeleteKeyAsync(String, CancellationToken) Methode

Definition

Namespace:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Paket:

Azure.Security.KeyVault.Keys v4.6.0

Quelle:

KeyClient.cs

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

Parameter

name

String

Der Name des Schlüssels.

cancellationToken

CancellationToken

Ein CancellationToken , der die Lebensdauer der Anforderung steuert.

Gibt zurück

Task<DeleteKeyOperation>

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 auf der ScheduledPurgeDategelöscht.

Ausnahmen

ArgumentException

name ist eine leere Zeichenfolge.

ArgumentNullException

name ist NULL.

RequestFailedException

Der Server hat einen Fehler zurückgegeben. Weitere Informationen, 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.