ApiResource.GetApiTag(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ApiResource.cs

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 Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagResource> GetApiTag (string tagId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetApiTag : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagResource>
override this.GetApiTag : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagResource>

Public Overridable Function GetApiTag (tagId As String, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<ApiTagResource>

Exceptions

ArgumentNullException

tagId is null.

ArgumentException

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