Share via


ApiResource.GetApiTagAsync(String, CancellationToken) Method

Definition

Get tag associated with the API.

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

Parameters

tagId
String

Tag identifier. Must be unique in the current API Management service instance.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

tagId is null.

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

Applies to