IApiTagDescriptionOperations.ListByServiceWithHttpMessagesAsync(String, String, String, ODataQuery<TagDescriptionContract>, Dictionary<String,List<String>>, CancellationToken) Method

Definition

Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations

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

Parameters

resourceGroupName
System.String

The name of the resource group.

serviceName
System.String

The name of the API Management service.

apiId
System.String

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

odataQuery
ODataQuery<TagDescriptionContract>

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<TagDescriptionContract>>>

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