Share via

ApiTagDescriptionCollection.GetAll 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:
ApiTagDescriptionCollection.cs
Source:
ApiTagDescriptionCollection.cs

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
public virtual Azure.Pageable<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource> GetAll (string filter = default, int? top = default, int? skip = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAll : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>
override this.GetAll : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>
Public Overridable Function GetAll (Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ApiTagDescriptionResource)

Parameters

filter
String

| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.

top
Nullable<Int32>

Number of records to return.

skip
Nullable<Int32>

Number of records to skip.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Pageable<ApiTagDescriptionResource>

A collection of ApiTagDescriptionResource that may take multiple service requests to iterate over.

Applies to