ApiManagementServiceResource.GetApisByTagsAsync Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.1.0

Source:

ApiManagementServiceResource.cs

Lists a collection of apis associated with tags.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags
• Operation Id: Api_ListByTags
• Default Api Version: 2021-08-01
• Resource: ApiResource

public virtual Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.TagResourceContractDetails> GetApisByTagsAsync (string filter = default, int? top = default, int? skip = default, bool? includeNotTaggedApis = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetApisByTagsAsync : string * Nullable<int> * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.TagResourceContractDetails>
override this.GetApisByTagsAsync : string * Nullable<int> * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.Models.TagResourceContractDetails>

Public Overridable Function GetApisByTagsAsync (Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional includeNotTaggedApis As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of TagResourceContractDetails)

Parameters

filter

String

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

top

Nullable<Int32>

Number of records to return.

skip

Nullable<Int32>

Number of records to skip.

includeNotTaggedApis

Nullable<Boolean>

Include not tagged APIs.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<TagResourceContractDetails>

An async collection of TagResourceContractDetails that may take multiple service requests to iterate over.