IGatewayOperations.ListByServiceWithHttpMessagesAsync Method

Definition

Lists a collection of gateways registered with service instance.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ApiManagement.Models.GatewayContract>>> ListByServiceWithHttpMessagesAsync (string resourceGroupName, string serviceName, Microsoft.Rest.Azure.OData.ODataQuery<Microsoft.Azure.Management.ApiManagement.Models.GatewayContract> odataQuery = 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.GatewayContract> * 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.GatewayContract>>>
Public Function ListByServiceWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, Optional odataQuery As ODataQuery(Of GatewayContract) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of GatewayContract)))

Parameters

resourceGroupName
System.String

The name of the resource group.

serviceName
System.String

The name of the API Management service.

odataQuery
ODataQuery<GatewayContract>

OData parameters to apply to the operation.

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

The headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

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

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Applies to