SecretClient.StartDeleteSecret(String, CancellationToken) Methode

Definition

Löscht ein Geheimnis aus einem angegebenen Schlüsseltresor.

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

Parameter

name
String

Der Name des Geheimnisses.

cancellationToken
CancellationToken

Ein CancellationToken , der die Lebensdauer der Anforderung steuert.

Gibt zurück

Ein DeleteSecretOperation , 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 das Geheimnis wiederherstellen oder bereinigen müssen. Andernfalls wird das Geheimnis automatisch auf der ScheduledPurgeDategelöscht.

Ausnahmen

name ist eine leere Zeichenfolge.

name ist NULL.

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

Hinweise

Der Löschvorgang gilt für alle in Azure Key Vault gespeicherten Geheimnisse. Löschen kann nicht auf eine einzelne Version eines Geheimnisses angewendet werden. Für diesen Vorgang ist die Berechtigung geheimnisse/lösch erforderlich.

Gilt für: