groups

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

Overview

Name	groups
Type	Resource
Id	azure.api_management.groups

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Group entity.

Name	Datatype	Description
properties	object	Group entity contract properties.

list_by_service

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
get	select	resourceGroupName, serviceName, groupId, subscriptionId		Gets the details of the group specified by its identifier.
list_by_service	select	resourceGroupName, serviceName, subscriptionId	$filter, $top, $skip	Lists a collection of groups defined within a service instance.
create_or_update	insert	resourceGroupName, serviceName, groupId, subscriptionId	If-Match	Creates or Updates a group.
update	update	resourceGroupName, serviceName, groupId, If-Match, subscriptionId		Updates the details of the group specified by its identifier.
delete	delete	resourceGroupName, serviceName, groupId, If-Match, subscriptionId		Deletes specific group of the API Management service instance.

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.
groupId	string	Group 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>| externalId | filter | eq | |</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.

SELECT examples

get

Gets the details of the group specified by its identifier.

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

list_by_service

Lists a collection of groups defined within a service instance.

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

INSERT examples

create_or_update

Creates or Updates a group.

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

Manifest

# Description fields are for documentation purposes
- name: groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the groups resource.
    - name: serviceName
      value: string
      description: Required parameter for the groups resource.
    - name: groupId
      value: string
      description: Required parameter for the groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the groups resource.
    - name: properties
      value: object
      description: |
        Properties supplied to Create Group operation.
    - 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

Updates the details of the group specified by its identifier.

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

DELETE examples

delete

Deletes specific group of the API Management service instance.

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