ApiManagementServiceResource.GetProductsByTags 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 products associated with tags.

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

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

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

Public Overridable Function GetProductsByTags (Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional includeNotTaggedProducts As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | substringof, contains, startswith, endswith |</br>.

top

Nullable<Int32>

Number of records to return.

skip

Nullable<Int32>

Number of records to skip.

includeNotTaggedProducts

Nullable<Boolean>

Include not tagged Products.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Pageable<TagResourceContractDetails>

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