KeyVaultClient.GetKeysWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.KeyVault

Assembly:

Microsoft.Azure.KeyVault.dll

Package:

Microsoft.Azure.KeyVault v3.0.5

Source:

KeyVaultClient.cs

List keys in the specified vault.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.KeyItem>>> GetKeysWithHttpMessagesAsync (string vaultBaseUrl, int? maxresults = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetKeysWithHttpMessagesAsync : 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.KeyItem>>>
override this.GetKeysWithHttpMessagesAsync : 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.KeyItem>>>

Public Function GetKeysWithHttpMessagesAsync (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 KeyItem)))

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

Implements

GetKeysWithHttpMessagesAsync(String, Nullable<Int32>, 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

Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.