KeyVaultClient.GetKeyWithHttpMessagesAsync Methode

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Paket:

Microsoft.Azure.KeyVault v3.0.5

Quelle:

KeyVaultClient.cs

Ruft den öffentlichen Teil eines gespeicherten Schlüssels ab.

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

abstract member GetKeyWithHttpMessagesAsync : string * 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.KeyBundle>>
override this.GetKeyWithHttpMessagesAsync : string * 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.KeyBundle>>

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

Parameter

vaultBaseUrl

String

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

keyName

String

Der Name des abzurufenden Schlüssels.

keyVersion

String

Durch das Hinzufügen des Versionsparameters wird eine bestimmte Version eines Schlüssels abgerufen.

customHeaders

Dictionary<String,List<String>>

Header, die der Anforderung hinzugefügt werden.

cancellationToken

CancellationToken

Das Abbruchtoken.

Gibt zurück

Task<AzureOperationResponse<KeyBundle>>

Implementiert

GetKeyWithHttpMessagesAsync(String, 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 Vorgang zum Abrufen von Schlüsseln gilt für alle Schlüsseltypen. Wenn der angeforderte Schlüssel symmetrisch ist, wird in der Antwort kein Schlüsselmaterial freigegeben. Dieser Vorgang erfordert die Schlüssel-/Get-Berechtigung.