product_groups

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

Overview

Name	product_groups
Type	Resource
Id	azure.api_management.product_groups

Fields

The following fields are returned by SELECT queries:

list_by_product

Lists a collection of Group entities.

Name	Datatype	Description
properties	object	Group entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_product	select	resourceGroupName, serviceName, productId, subscriptionId	$filter, $top, $skip	Lists the collection of developer groups associated with the specified product.
create_or_update	insert	resourceGroupName, serviceName, productId, groupId, subscriptionId		Adds the association between the specified developer group with the specified product.
delete	delete	resourceGroupName, serviceName, productId, groupId, subscriptionId		Deletes the association between the specified group and 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
groupId	string	Group identifier. Must be unique in the current API Management service instance.
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 | |</br>| displayName | filter | eq, ne | |</br>| description | filter | eq, ne | |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.

SELECT examples

list_by_product

Lists the collection of developer groups associated with the specified product.

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

INSERT examples

create_or_update

Adds the association between the specified developer group with the specified product.

INSERT INTO azure.api_management.product_groups (
resourceGroupName,
serviceName,
productId,
groupId,
subscriptionId
)
SELECT 
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ productId }}',
'{{ groupId }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: product_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the product_groups resource.
    - name: serviceName
      value: string
      description: Required parameter for the product_groups resource.
    - name: productId
      value: string
      description: Required parameter for the product_groups resource.
    - name: groupId
      value: string
      description: Required parameter for the product_groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the product_groups resource.

DELETE examples

delete

Deletes the association between the specified group and product.

DELETE FROM azure.api_management.product_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND productId = '{{ productId }}' --required
AND groupId = '{{ groupId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;