KeyVaultClient.PurgeDeletedKeyWithHttpMessagesAsync Methode

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Paket:

Microsoft.Azure.KeyVault v3.0.5

Quelle:

KeyVaultClient.cs

Löscht den angegebenen Schlüssel endgültig.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> PurgeDeletedKeyWithHttpMessagesAsync (string vaultBaseUrl, string keyName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PurgeDeletedKeyWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
override this.PurgeDeletedKeyWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>

Public Function PurgeDeletedKeyWithHttpMessagesAsync (vaultBaseUrl As String, keyName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameter

vaultBaseUrl

String

Der Tresorname, z. B https://myvault.vault.azure.net. .

keyName

String

Der Name des Schlüssels

customHeaders

Dictionary<String,List<String>>

Header, die der Anforderung hinzugefügt werden.

cancellationToken

CancellationToken

Das Abbruchtoken.

Gibt zurück

Task<AzureOperationResponse>

Implementiert

PurgeDeletedKeyWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken)

Ausnahmen

KeyVaultErrorException

Wird ausgelöst, wenn der Vorgang einen ungültigen status Code zurückgegeben hat.

ValidationException

Wird ausgelöst, wenn ein erforderlicher Parameter NULL ist

ArgumentNullException

Wird ausgelöst, wenn ein erforderlicher Parameter NULL ist

Hinweise

Der Vorgang Gelöschter Schlüssel löschen gilt für vorläufiges Löschen aktivierter Tresore. Der Vorgang kann zwar für einen beliebigen Tresor aufgerufen werden, gibt jedoch einen Fehler zurück, wenn er für einen Tresor ohne vorläufiges Löschen aufgerufen wird. Für diesen Vorgang ist die Berechtigung schlüssel/bereinigen erforderlich.