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

Definition

List certificates in a specified key vault

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

Parameters

vaultBaseUrl
System.String

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

maxresults
System.Nullable<System.Int32>

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

includePending
System.Nullable<System.Boolean>

Specifies whether to include certificates which are not completely provisioned.

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

Headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<AzureOperationResponse<IPage<CertificateItem>>>

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

System.ArgumentNullException

Thrown when a required parameter is null

Remarks

The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

Applies to