IProductOperations.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 products in the specified service instance.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ApiManagement.Models.ProductContract>>> ListByServiceWithHttpMessagesAsync (string resourceGroupName, string serviceName, Microsoft.Rest.Azure.OData.ODataQuery<Microsoft.Azure.Management.ApiManagement.Models.ProductContract> odataQuery = default, bool? expandGroups = default, string tags = 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.ProductContract> * Nullable<bool> * string * 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.ProductContract>>>

Public Function ListByServiceWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, Optional odataQuery As ODataQuery(Of ProductContract) = Nothing, Optional expandGroups As Nullable(Of Boolean) = Nothing, Optional tags As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of ProductContract)))

Parameters

resourceGroupName

String

The name of the resource group.

serviceName

String

The name of the API Management service.

odataQuery

ODataQuery<ProductContract>

OData parameters to apply to the operation.

expandGroups

Nullable<Boolean>

When set to true, the response contains an array of groups that have visibility to the product. The default is false.

tags

String

Products which are part of a specific tag.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<ProductContract>>>

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