Microsoft.Management managementGroups
The managementGroups resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource.
- For Bicep, see Set scope on extension resources in Bicep.
- For JSON, see Set scope on extension resources in ARM templates.
Valid deployment scopes for the managementGroups resource are:
- Tenant
Remarks
When deployed at tenant scope, don't set the scope property. See create management groups with tenant deployments in Bicep file or ARM templates.
When deployed at other scopes, set the scope property to tenant() for Bicep files or / for ARM templates. See create management groups with management group deployments in Bicep file or ARM templates.
Template format
To create a Microsoft.Management/managementGroups resource, add the following Bicep or JSON to your template.
resource symbolicname 'Microsoft.Management/managementGroups@2021-04-01' = {
name: 'string'
scope: tenant()
properties: {
details: {
parent: {
id: 'string'
}
}
displayName: 'string'
}
}
Property values
managementGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.Management/managementGroups' |
| apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2021-04-01' |
| name | The resource name | string (required) |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | For Bicep: tenant(). For JSON: /. |
| properties | The generic properties of a management group used during creation. | CreateManagementGroupProperties |
CreateManagementGroupProperties
| Name | Description | Value |
|---|---|---|
| details | The details of a management group used during creation. | CreateManagementGroupDetails |
| displayName | The friendly name of the management group. If no value is passed then this field will be set to the groupId. | string |
CreateManagementGroupDetails
| Name | Description | Value |
|---|---|---|
| parent | (Optional) The ID of the parent management group used during creation. | CreateParentGroupInfo |
CreateParentGroupInfo
| Name | Description | Value |
|---|---|---|
| id | The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create a New Management Group |
This template is a tenant level template that will create a new management group. |