KeyVaultClient.PurgeDeletedSecretWithHttpMessagesAsync Methode

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Paket:

Microsoft.Azure.KeyVault v3.0.5

Quelle:

KeyVaultClient.cs

Löscht das angegebene Geheimnis endgültig.

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

abstract member PurgeDeletedSecretWithHttpMessagesAsync : 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.PurgeDeletedSecretWithHttpMessagesAsync : 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 PurgeDeletedSecretWithHttpMessagesAsync (vaultBaseUrl As String, secretName 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. .

secretName

String

Der Name des Geheimnisses.

customHeaders

Dictionary<String,List<String>>

Header, die der Anforderung hinzugefügt werden.

cancellationToken

CancellationToken

Das Abbruchtoken.

Gibt zurück

Task<AzureOperationResponse>

Implementiert

PurgeDeletedSecretWithHttpMessagesAsync(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

Durch den Löschen des gelöschten Geheimnisses wird das Geheimnis dauerhaft entfernt, ohne dass die Möglichkeit einer Wiederherstellung besteht. Dieser Vorgang kann nur in einem Tresor mit vorläufigem Löschen aktiviert werden. Für diesen Vorgang ist die Berechtigung Geheimnisse/Löschen erforderlich.