IKeyVaultClient.GetSecretWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.KeyVault

Assembly:: Microsoft.Azure.KeyVault.dll

Package:: Microsoft.Azure.KeyVault v3.0.5

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get a specified secret from a given key vault.

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

abstract member GetSecretWithHttpMessagesAsync : 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.SecretBundle>>

Public Function GetSecretWithHttpMessagesAsync (vaultBaseUrl As String, secretName As String, secretVersion As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of SecretBundle))

Parameters

vaultBaseUrl: String

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

secretName: String

The name of the secret.

secretVersion: String

The version of the secret.

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<SecretBundle>>

Remarks

The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.

Applies to