ApiTagCollection.GetIfExistsAsync(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:: ApiTagCollection.cs

Source:: ApiTagCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Tries to get details for this resource from the service.

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

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.ApiManagement.ApiTagResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.ApiManagement.ApiTagResource>>

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

Task<NullableResponse<ApiTagResource>>

Exceptions

ArgumentException

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

ArgumentNullException

tagId is null.

Applies to

Share via