KeyVaultClientExtensions.GetSecretsAsync(IKeyVaultClient, String, Nullable<Int32>, CancellationToken) Method

Definition

List secrets in a specified key vault.

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.SecretItem>> GetSecretsAsync (this Microsoft.Azure.KeyVault.IKeyVaultClient operations, string vaultBaseUrl, int? maxresults = default, System.Threading.CancellationToken cancellationToken = default);
static member GetSecretsAsync : Microsoft.Azure.KeyVault.IKeyVaultClient * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.SecretItem>>
<Extension()>
Public Function GetSecretsAsync (operations As IKeyVaultClient, vaultBaseUrl As String, Optional maxresults As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of SecretItem))

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

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