ApiManagementProductCollection.GetAllAsync Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ApiManagementProductCollection.cs

Lists a collection of products in the specified service instance.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products
• Operation Id: Product_ListByService
• Default Api Version: 2023-03-01-preview
• Resource: ApiManagementProductResource

public virtual Azure.AsyncPageable<Azure.ResourceManager.ApiManagement.ApiManagementProductResource> GetAllAsync (string filter = default, int? top = default, int? skip = default, bool? expandGroups = default, string tags = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetAllAsync (Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional expandGroups As Nullable(Of Boolean) = Nothing, Optional tags As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ApiManagementProductResource)

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 | |</br>| groups | expand | | |</br>.

top

Nullable<Int32>

Number of records to return.

skip

Nullable<Int32>

Number of records to skip.

expandGroups

Nullable<Boolean>

When set to true, the response contains an array of groups that have visibility to the product. The default is false.

tags

String

Products which are part of a specific tag.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<ApiManagementProductResource>

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