Microsoft.ApiManagement service/groups 2019-12-01

The service/groups resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.ApiManagement/service/groups resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.ApiManagement/service/groups@2019-12-01' = {
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    externalId: 'string'
    type: 'string'
  }
}

Property values

service/groups

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ApiManagement/service/groups'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2019-12-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties Group contract Properties. GroupCreateParametersProperties

GroupCreateParametersProperties

Name Description Value
description Group description. Can contain HTML formatting tags. string
displayName Group name. string (required)
externalId For 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. string
type Group type. 'custom'
'external'
'system'

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