ApiTagDescriptionCollection.Get(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 Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource> Get (string tagDescriptionId, System.Threading.CancellationToken cancellationToken = default);
abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>
Public Overridable Function Get (tagDescriptionId As String, Optional cancellationToken As CancellationToken = Nothing) As 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