KeyVaultClient.GetKeyWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Package:

Microsoft.Azure.KeyVault v3.0.5

Source:

KeyVaultClient.cs

Gets the public part of a stored key.

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

Parameters

vaultBaseUrl

String

The vault name, for example https://myvault.vault.azure.net.

keyName

String

The name of the key to get.

keyVersion

String

Adding the version parameter retrieves a specific version of a key.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<KeyBundle>>

Implements

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

Exceptions

KeyVaultErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null

Remarks

The get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission.