Share via


IApiTagDescriptionOperations.GetWithHttpMessagesAsync Method

Definition

Get Tag description in scope of API

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.TagDescriptionContract,Microsoft.Azure.Management.ApiManagement.Models.ApiTagDescriptionGetHeaders>> GetWithHttpMessagesAsync (string resourceGroupName, string serviceName, string apiId, string tagDescriptionId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ApiManagement.Models.TagDescriptionContract, Microsoft.Azure.Management.ApiManagement.Models.ApiTagDescriptionGetHeaders>>
Public Function GetWithHttpMessagesAsync (resourceGroupName As String, serviceName As String, apiId As String, tagDescriptionId As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of TagDescriptionContract, ApiTagDescriptionGetHeaders))

Parameters

resourceGroupName
String

The name of the resource group.

serviceName
String

The name of the API Management service.

apiId
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.

tagDescriptionId
String

Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

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