Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
Bicep resource definition
The managementGroups resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Management/managementGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Management/managementGroups@2017-11-01-preview' = {
scope: resourceSymbolicName or scope
displayName: 'string'
name: 'string'
parentId: 'string'
}
Property Values
Microsoft.Management/managementGroups
| Name | Description | Value |
|---|---|---|
| displayName | The friendly name of the management group. | string |
| name | The resource name | string (required) |
| parentId | (Optional) The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 | string |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Management Group | AVM Resource Module for Management Group |
ARM template resource definition
The managementGroups resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Management/managementGroups resource, add the following JSON to your template.
{
"type": "Microsoft.Management/managementGroups",
"apiVersion": "2017-11-01-preview",
"name": "string",
"displayName": "string",
"parentId": "string"
}
Property Values
Microsoft.Management/managementGroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2017-11-01-preview' |
| displayName | The friendly name of the management group. | string |
| name | The resource name | string (required) |
| parentId | (Optional) The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 | string |
| type | The resource type | 'Microsoft.Management/managementGroups' |
Usage Examples
Azure Quickstart Templates
The following Azure 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. |
Terraform (AzAPI provider) resource definition
The managementGroups resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Management/managementGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Management/managementGroups@2017-11-01-preview"
name = "string"
parent_id = "string"
body = {
displayName = "string"
parentId = "string"
}
}
Property Values
Microsoft.Management/managementGroups
| Name | Description | Value |
|---|---|---|
| displayName | The friendly name of the management group. | string |
| name | The resource name | string (required) |
| parentId | (Optional) The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 | string |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| type | The resource type | "Microsoft.Management/managementGroups@2017-11-01-preview" |