SecretClient.StartDeleteSecretAsync(String, CancellationToken) Methode

Definition

Namespace:

Azure.Security.KeyVault.Secrets

Assembly:

Azure.Security.KeyVault.Secrets.dll

Paket:

Azure.Security.KeyVault.Secrets v4.6.0

Quelle:

SecretClient.cs

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

public virtual System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation> StartDeleteSecretAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member StartDeleteSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation>
override this.StartDeleteSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Security.KeyVault.Secrets.DeleteSecretOperation>

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

Parameter

name

String

Der Name des Geheimnisses.

cancellationToken

CancellationToken

Ein CancellationToken , der die Lebensdauer der Anforderung steuert.

Gibt zurück

Task<DeleteSecretOperation>

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

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 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.