IKeyVaultClient.GetKeysWithHttpMessagesAsync(String, Nullable<Int32>, Dictionary<String,List<String>>, CancellationToken) Method

Definition

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, Nullable<int> maxresults = null, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = null, System.Threading.CancellationToken cancellationToken = null);
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>>>

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

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<KeyItem>>>

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.

Authorization: Requires the keys/list permission.

Applies to