IGatewayApiOperations.ListByServiceWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.ApiManagement

Assembly:

Microsoft.Azure.Management.ApiManagement.dll

Package:

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

Lists a collection of the APIs associated with a gateway.

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

abstract member ListByServiceWithHttpMessagesAsync : string * string * string * Microsoft.Rest.Azure.OData.ODataQuery<Microsoft.Azure.Management.ApiManagement.Models.ApiContract> * 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, gatewayId As String, Optional odataQuery As ODataQuery(Of ApiContract) = 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.

gatewayId

String

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

odataQuery

ODataQuery<ApiContract>

OData parameters to apply to the operation.

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