user_group

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

Overview

Name	user_group
Type	Resource
Id	azure.api_management.user_group

Fields

The following fields are returned by SELECT queries:

list

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.
builtIn	boolean	true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
description	string	Group description. Can contain HTML formatting tags.
displayName	string	Group name. Required.
externalId	string	For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null.
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
list	select	resource_group_name, service_name, user_id, subscription_id	$filter, $top, $skip	Lists all user groups.

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
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
user_id	string	User identifier. Must be unique in the current API Management service instance. Required.
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|------------------------|-----------------------------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | 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

list

Lists all user groups.

SELECT
id,
name,
builtIn,
description,
displayName,
externalId,
systemData,
type
FROM azure.api_management.user_group
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND user_id = '{{ user_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;