group_users

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

Overview

Name	group_users
Type	Resource
Id	azure.api_management.group_users

Fields

The following fields are returned by SELECT queries:

list

Lists a collection of user entities associated with the group.

Name	Datatype	Description
properties	object	User entity contract properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, serviceName, groupId, subscriptionId	$filter, $top, $skip	Lists a collection of user entities associated with the group.
create	insert	resourceGroupName, serviceName, groupId, userId, subscriptionId		Add existing user to existing group
delete	delete	resourceGroupName, serviceName, groupId, userId, subscriptionId		Remove existing user from existing group.

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.
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.
userId	string	User identifier. Must be unique in the current API Management service instance.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| registrationDate | filter | ge, le, eq, ne, gt, lt | |</br>| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.

SELECT examples

list

Lists a collection of user entities associated with the group.

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

INSERT examples

create

Add existing user to existing group

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

Manifest

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

DELETE examples

delete

Remove existing user from existing group.

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