KeyVaultClient.DeleteSecretWithHttpMessagesAsync Methode

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Paket:

Microsoft.Azure.KeyVault v3.0.5

Quelle:

KeyVaultClient.cs

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

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

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

Public Function DeleteSecretWithHttpMessagesAsync (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(Of DeletedSecretBundle))

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

Implementiert

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

Ausnahmen

KeyVaultErrorException

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

SerializationException

Wird ausgelöst, wenn die Antwort nicht deserialisiert werden kann

ValidationException

Wird ausgelöst, wenn ein erforderlicher Parameter NULL ist

ArgumentNullException

Wird ausgelöst, wenn ein erforderlicher Parameter NULL ist

Hinweise

Der DELETE-Vorgang gilt für alle geheimen Schlüssel, die im Azure-Schlüsseltresor gespeichert sind. DELETE kann nicht auf eine einzelne Version eines geheimen Schlüssels angewendet werden. Für diesen Vorgang ist die Berechtigung geheimnisse/löschen erforderlich.