api_products

Creates, updates, deletes, gets or lists an api_products resource.

Overview

Name	api_products
Type	Resource
Id	azure.api_management.api_products

Fields

The following fields are returned by SELECT queries:

list_by_apis

The operation returns a collection of products which have the Api entity.

Name	Datatype	Description
properties	object	Product entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_apis	select	resourceGroupName, serviceName, apiId, subscriptionId	$filter, $top, $skip	Lists all Products, which the API is part of.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
apiId	string	API identifier. Must be unique in the current API Management service instance.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.

SELECT examples

list_by_apis

Lists all Products, which the API is part of.

SELECT
properties
FROM azure.api_management.api_products
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;