IApiOperations.ListByServiceWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.ApiManagement

Assembly:

Microsoft.Azure.Management.ApiManagement.dll

Package:

Microsoft.Azure.Management.ApiManagement v8.0.0-preview

Lists all APIs of the API Management service instance. https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ApiManagement.Models.ApiContract>>> ListByServiceWithHttpMessagesAsync (string resourceGroupName, string serviceName, Microsoft.Rest.Azure.OData.ODataQuery<Microsoft.Azure.Management.ApiManagement.Models.ApiContract> odataQuery = default, string tags = default, bool? expandApiVersionSet = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ListByServiceWithHttpMessagesAsync : string * string * Microsoft.Rest.Azure.OData.ODataQuery<Microsoft.Azure.Management.ApiManagement.Models.ApiContract> * string * 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.Management.ApiManagement.Models.ApiContract>>>

Public Function ListByServiceWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, Optional odataQuery As ODataQuery(Of ApiContract) = Nothing, Optional tags As String = Nothing, Optional expandApiVersionSet 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 ApiContract)))

Parameters

resourceGroupName

String

The name of the resource group.

serviceName

String

The name of the API Management service.

odataQuery

ODataQuery<ApiContract>

OData parameters to apply to the operation.

tags

String

Include tags in the response.

expandApiVersionSet

Nullable<Boolean>

Include full ApiVersionSet resource in response

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<ApiContract>>>

Exceptions

ErrorResponseException

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