KeyVaultClient.GetSecretsWithHttpMessagesAsync(String, Nullable<Int32>, Dictionary<String,List<String>>, CancellationToken) Method

Definition

List secrets in a specified key vault.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.SecretItem>>> GetSecretsWithHttpMessagesAsync (string vaultBaseUrl, int? maxresults = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSecretsWithHttpMessagesAsync : string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.SecretItem>>>
override this.GetSecretsWithHttpMessagesAsync : string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.SecretItem>>>
Public Function GetSecretsWithHttpMessagesAsync (vaultBaseUrl As String, Optional maxresults As Nullable(Of Integer) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of SecretItem)))

Parameters

vaultBaseUrl
String

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

maxresults
Nullable<Int32>

Maximum number of results to return in a page. If not specified, the service will return up to 25 results.

customHeaders
Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<SecretItem>>>

Implements

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Thrown when a required parameter is null

Remarks

The Get Secrets operation is applicable to the entire vault. However, only

the base secret identifier and its attributes are provided in the response.

Individual secret versions are not listed in the response. This operation

requires the secrets/list permission.

Applies to