groups

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

Overview

Name	groups
Type	Resource
Id	azure.api_management.groups

Fields

vw_groups

Name	Datatype	Description
description	text	field from the properties object
built_in	text	field from the properties object
display_name	text	field from the properties object
external_id	text	field from the properties object
groupId	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	field from the properties object

groups

Name	Datatype	Description
properties	object	Group contract Properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	groupId, resourceGroupName, serviceName, subscriptionId	Gets the details of the group specified by its identifier.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists a collection of groups defined within a service instance.
create_or_update	INSERT	groupId, resourceGroupName, serviceName, subscriptionId	Creates or Updates a group.
delete	DELETE	If-Match, groupId, resourceGroupName, serviceName, subscriptionId	Deletes specific group of the API Management service instance.
update	UPDATE	If-Match, groupId, resourceGroupName, serviceName, subscriptionId	Updates the details of the group specified by its identifier.

SELECT examples

Lists a collection of groups defined within a service instance.

vw_groups

SELECT
description,
built_in,
display_name,
external_id,
groupId,
resourceGroupName,
serviceName,
subscriptionId,
type
FROM azure.api_management.vw_groups
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

groups

SELECT
properties
FROM azure.api_management.groups
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new groups resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.groups (
groupId,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ groupId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: displayName
          value: string
        - name: description
          value: string
        - name: type
          value: string
        - name: externalId
          value: string

UPDATE example

Updates a groups resource.

/*+ update */
UPDATE azure.api_management.groups
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND groupId = '{{ groupId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified groups resource.

/*+ delete */
DELETE FROM azure.api_management.groups
WHERE If-Match = '{{ If-Match }}'
AND groupId = '{{ groupId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';