Share via


ApiTagDescriptionCollection.GetAsync(String, CancellationToken) Method

Definition

Get Tag description in scope of API

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
  • Operation Id: ApiTagDescription_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagDescriptionResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>> GetAsync (string tagDescriptionId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>>
Public Overridable Function GetAsync (tagDescriptionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ApiTagDescriptionResource))

Parameters

tagDescriptionId
String

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

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

tagDescriptionId is an empty string, and was expected to be non-empty.

tagDescriptionId is null.

Applies to