Condividi tramite


ApiTagDescriptionCollection Class

Definition

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

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

Constructors

ApiTagDescriptionCollection()

Initializes a new instance of the ApiTagDescriptionCollection 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, ApiTagDescriptionCreateOrUpdateContent, Nullable<ETag>, CancellationToken)

Create/Update tag description in scope of the Api.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
  • Operation Id: ApiTagDescription_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagDescriptionResource
CreateOrUpdateAsync(WaitUntil, String, ApiTagDescriptionCreateOrUpdateContent, Nullable<ETag>, CancellationToken)

Create/Update tag description in scope of the Api.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
  • Operation Id: ApiTagDescription_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagDescriptionResource
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}/tagDescriptions/{tagDescriptionId}
  • Operation Id: ApiTagDescription_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagDescriptionResource
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}/tagDescriptions/{tagDescriptionId}
  • Operation Id: ApiTagDescription_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagDescriptionResource
Get(String, CancellationToken)

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

Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations

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

Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations

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

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
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}/tagDescriptions/{tagDescriptionId}
  • Operation Id: ApiTagDescription_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagDescriptionResource
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}/tagDescriptions/{tagDescriptionId}
  • Operation Id: ApiTagDescription_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ApiTagDescriptionResource
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<ApiTagDescriptionResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ApiTagDescriptionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to