다음을 통해 공유

ApiResource.GetApiTagDescription(String, CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApiManagement
Assembly:
Azure.ResourceManager.ApiManagement.dll
Package:
Azure.ResourceManager.ApiManagement v1.2.0
Package:
Azure.ResourceManager.ApiManagement v1.3.0-beta.1
Source:
ApiResource.cs
Source:
ApiResource.cs

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

Response<ApiTagDescriptionResource>

Exceptions

ArgumentNullException

tagDescriptionId is null.

ArgumentException

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

Applies to