product_group_link

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

Overview

Name	product_group_link
Type	Resource
Id	azure.api_management.product_group_link

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
groupId	string	Full resource Id of a group. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_product

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
groupId	string	Full resource Id of a group. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, product_id, group_link_id, subscription_id		Gets the group link for the product.
list_by_product	select	resource_group_name, service_name, product_id, subscription_id	$filter, $top, $skip	Lists a collection of the group links associated with a product.
create_or_update	insert	resource_group_name, service_name, product_id, group_link_id, subscription_id		Adds a group to the specified product via link.
create_or_update	replace	resource_group_name, service_name, product_id, group_link_id, subscription_id		Adds a group to the specified product via link.
delete	delete	resource_group_name, service_name, product_id, group_link_id, subscription_id		Deletes the specified group from the specified 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
group_link_id	string	Product-Group link identifier. Must be unique in the current API Management service instance. Required.
product_id	string	Product identifier. Must be unique in the current API Management service instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| groupId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the group link for the product.

SELECT
id,
name,
groupId,
systemData,
type
FROM azure.api_management.product_group_link
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND product_id = '{{ product_id }}' -- required
AND group_link_id = '{{ group_link_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_product

Lists a collection of the group links associated with a product.

SELECT
id,
name,
groupId,
systemData,
type
FROM azure.api_management.product_group_link
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND product_id = '{{ product_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Adds a group to the specified product via link.

INSERT INTO azure.api_management.product_group_link (
properties,
resource_group_name,
service_name,
product_id,
group_link_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ product_id }}',
'{{ group_link_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: product_group_link
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the product_group_link resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the product_group_link resource.
  - name: product_id
    value: "{{ product_id }}"
    description: Required parameter for the product_group_link resource.
  - name: group_link_id
    value: "{{ group_link_id }}"
    description: Required parameter for the product_group_link resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the product_group_link resource.
  - name: properties
    description: |
      Product-group link entity contract properties.
    value:
      groupId: "{{ groupId }}"

REPLACE examples

create_or_update

Adds a group to the specified product via link.

REPLACE azure.api_management.product_group_link
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND product_id = '{{ product_id }}' --required
AND group_link_id = '{{ group_link_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified group from the specified product.

DELETE FROM azure.api_management.product_group_link
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND product_id = '{{ product_id }}' --required
AND group_link_id = '{{ group_link_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;