Microsoft.ApiManagement service/groups

Template format

To create a Microsoft.ApiManagement/service/groups resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.ApiManagement/service/groups",
  "apiVersion": "2020-06-01-preview",
  "properties": {
    "displayName": "string",
    "description": "string",
    "type": "string",
    "externalId": "string"
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ApiManagement/service/groups object

Name Type Required Value
name string Yes Group identifier. Must be unique in the current API Management service instance.
type enum Yes groups
-or-
Microsoft.ApiManagement/service/groups

See Set name and type for child resources.
apiVersion enum Yes 2020-06-01-preview
properties object Yes Properties supplied to Create Group operation. - GroupCreateParametersProperties object
resources array No users

GroupCreateParametersProperties object

Name Type Required Value
displayName string Yes Group name.
description string No Group description.
type enum No Group type. - custom, system, external
externalId string No Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an API Management instance and all sub resources using template

Deploy to Azure
This template demonstrates how to create a API Management service and configure sub-entities