products

Creates, updates, deletes, gets or lists a products resource.

Overview

Name	products
Type	Resource
Id	azure.api_management.products

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Product entity.

Name	Datatype	Description
properties	object	Product entity contract properties.

list_by_service

A Collection of the Product entities for the specified API Management service instance.

Name	Datatype	Description
properties	object	Product entity contract properties.

list_by_tags

Lists a collection of TagResource entities.

Name	Datatype	Description
api	object	API associated with the tag.
operation	object	Operation associated with the tag.
product	object	Product associated with the tag.
tag	object	Tag associated with the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, productId, subscriptionId		Gets the details of the product specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip, expandGroups, tags	Lists a collection of products in the specified service instance.
list_by_tags	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip, includeNotTaggedProducts	Lists a collection of products associated with tags.
create_or_update	insert	resourceGroupName, serviceName, productId, subscriptionId	If-Match	Creates or Updates a product.
update	update	resourceGroupName, serviceName, productId, If-Match, subscriptionId		Update existing product details.
delete	delete	resourceGroupName, serviceName, productId, If-Match, subscriptionId	deleteSubscriptions	Delete product.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
productId	string	Product 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>| 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>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.
deleteSubscriptions	boolean	Delete existing subscriptions associated with the product or not.
expandGroups	boolean	When set to true, the response contains an array of groups that have visibility to the product. The default is false.
includeNotTaggedProducts	boolean	Include not tagged Products.
tags	string	Products which are part of a specific tag.

SELECT examples

get

Gets the details of the product specified by its identifier.

SELECT
properties
FROM azure.api_management.products
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND productId = '{{ productId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

Lists a collection of products in the specified service instance.

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

list_by_tags

Lists a collection of products associated with tags.

SELECT
api,
operation,
product,
tag
FROM azure.api_management.products
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND includeNotTaggedProducts = '{{ includeNotTaggedProducts }}'
;

INSERT examples

create_or_update

Creates or Updates a product.

INSERT INTO azure.api_management.products (
data__properties,
resourceGroupName,
serviceName,
productId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ productId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: products
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the products resource.
    - name: serviceName
      value: string
      description: Required parameter for the products resource.
    - name: productId
      value: string
      description: Required parameter for the products resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the products resource.
    - name: properties
      value: object
      description: |
        Product entity contract properties.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

Update existing product details.

UPDATE azure.api_management.products
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND productId = '{{ productId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Delete product.

DELETE FROM azure.api_management.products
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND productId = '{{ productId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND deleteSubscriptions = '{{ deleteSubscriptions }}'
;