Microsoft.Management managementGroups

• Latest
• 2023-04-01
• 2021-04-01
• 2020-10-01
• 2020-05-01
• 2020-02-01
• 2019-11-01
• 2018-03-01-preview
• 2018-01-01-preview
• 2017-11-01-preview

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:

• Tenant - See tenant deployment commands

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@2023-04-01' = {
  name: 'string'
  properties: {
    details: {
      parent: {
        id: 'string'
      }
    }
    displayName: 'string'
  }
}

Property values

CreateManagementGroupDetailsOrManagementGroupDetails

Name	Description	Value
parent	(Optional) The ID of the parent management group used during creation.	CreateParentGroupInfoOrParentGroupInfo

CreateManagementGroupPropertiesOrManagementGroupProperties

Name	Description	Value
details	The details of a management group used during creation.	CreateManagementGroupDetailsOrManagementGroupDetails
displayName	The friendly name of the management group. If no value is passed then this field will be set to the groupId.	string

CreateParentGroupInfoOrParentGroupInfo

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

Microsoft.Management/managementGroups

Name	Description	Value
name	The resource name	string (required)
properties	The generic properties of a management group used during creation.	CreateManagementGroupPropertiesOrManagementGroupProperties

ARM template resource definition

The managementGroups resource type can be deployed with operations that target:

• Tenant - See tenant deployment commands

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": "2023-04-01",
  "name": "string",
  "properties": {
    "details": {
      "parent": {
        "id": "string"
      }
    },
    "displayName": "string"
  }
}

Property values

CreateManagementGroupDetailsOrManagementGroupDetails

Name	Description	Value
parent	(Optional) The ID of the parent management group used during creation.	CreateParentGroupInfoOrParentGroupInfo

CreateManagementGroupPropertiesOrManagementGroupProperties

Name	Description	Value
details	The details of a management group used during creation.	CreateManagementGroupDetailsOrManagementGroupDetails
displayName	The friendly name of the management group. If no value is passed then this field will be set to the groupId.	string

CreateParentGroupInfoOrParentGroupInfo

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

Microsoft.Management/managementGroups

Name	Description	Value
apiVersion	The api version	'2023-04-01'
name	The resource name	string (required)
properties	The generic properties of a management group used during creation.	CreateManagementGroupPropertiesOrManagementGroupProperties
type	The resource type	'Microsoft.Management/managementGroups'

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.

Terraform (AzAPI provider) resource definition

The managementGroups resource type can be deployed with operations that target:

• Tenant

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@2023-04-01"
  name = "string"
  body = jsonencode({
    properties = {
      details = {
        parent = {
          id = "string"
        }
      }
      displayName = "string"
    }
  })
}

Property values

CreateManagementGroupDetailsOrManagementGroupDetails

Name	Description	Value
parent	(Optional) The ID of the parent management group used during creation.	CreateParentGroupInfoOrParentGroupInfo

CreateManagementGroupPropertiesOrManagementGroupProperties

Name	Description	Value
details	The details of a management group used during creation.	CreateManagementGroupDetailsOrManagementGroupDetails
displayName	The friendly name of the management group. If no value is passed then this field will be set to the groupId.	string

CreateParentGroupInfoOrParentGroupInfo

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

Microsoft.Management/managementGroups

Name	Description	Value
name	The resource name	string (required)
properties	The generic properties of a management group used during creation.	CreateManagementGroupPropertiesOrManagementGroupProperties
type	The resource type	"Microsoft.Management/managementGroups@2023-04-01"