Share via


ApiTagCollection Class

Definition

A class representing a collection of ApiTagResource and their operations. Each ApiTagResource in the collection will belong to the same instance of ApiResource. To get an ApiTagCollection instance call the GetApiTags method from an instance of ApiResource.

public class ApiTagCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.ApiManagement.ApiTagResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.ApiTagResource>
type ApiTagCollection = class
    inherit ArmCollection
    interface seq<ApiTagResource>
    interface IEnumerable
    interface IAsyncEnumerable<ApiTagResource>
Public Class ApiTagCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ApiTagResource), IEnumerable(Of ApiTagResource)
Inheritance
ApiTagCollection
Implements

Constructors

ApiTagCollection()

Initializes a new instance of the ApiTagCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, CancellationToken)

Assign tag to the Api.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}
  • Operation Id: Tag_AssignToApi
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagResource
CreateOrUpdateAsync(WaitUntil, String, CancellationToken)

Assign tag to the Api.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}
  • Operation Id: Tag_AssignToApi
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • 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
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • 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
Get(String, CancellationToken)

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
GetAll(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all Tags associated with the API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags
  • Operation Id: Tag_ListByApi
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagResource
GetAllAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all Tags associated with the API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags
  • Operation Id: Tag_ListByApi
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagResource
GetAsync(String, CancellationToken)

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
GetIfExists(String, CancellationToken)

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
GetIfExistsAsync(String, CancellationToken)

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
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<ApiTagResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiTagResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to