KeyVaultClientExtensions.GetKeysAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.KeyVault

Assembly:: Microsoft.Azure.KeyVault.dll

Package:: Microsoft.Azure.KeyVault v3.0.5

Source:: KeyVaultClientExtensions.cs

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.

List keys in the specified vault.

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.KeyItem>> GetKeysAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, int? maxresults = default, System.Threading.CancellationToken cancellationToken = default);

static member GetKeysAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.KeyItem>>

<Extension()>
Public Function GetKeysAsync (operations As IKeyVaultClient, vaultBaseUrl As String, Optional maxresults As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of KeyItem))

Parameters

operations: IKeyVaultClient

The operations group for this extension method.

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.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<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. This operation requires the keys/list permission.

Applies to