Microsoft.Management managementGroups 2020-10-01

Bicep resource definition

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. See Set scope on extension resources in Bicep.

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

For a list of changed properties in each API version, see change log.

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.

Resource format

To create a Microsoft.Management/managementGroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Management/managementGroups@2020-10-01' = {
  name: 'string'
  scope: tenant()
  properties: {
    details: {
      parent: {
        id: 'string'
      }
    }
    displayName: 'string'
  }
}

Property values

managementGroups

Name Description Value
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().
properties The generic properties of a management group used during creation. CreateManagementGroupPropertiesOrManagementGroupProp...

CreateManagementGroupPropertiesOrManagementGroupProp...

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

CreateManagementGroupDetailsOrManagementGroupDetails

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

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a New Management Group

Deploy to Azure
This template is a tenant level template that will create a new management group.

ARM template resource definition

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. See Set scope on extension resources in ARM templates.

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

For a list of changed properties in each API version, see change log.

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.

Resource format

To create a Microsoft.Management/managementGroups resource, add the following JSON to your template.

{
  "type": "Microsoft.Management/managementGroups",
  "apiVersion": "2020-10-01",
  "name": "string",
  "scope": "/",
  "properties": {
    "details": {
      "parent": {
        "id": "string"
      }
    },
    "displayName": "string"
  }
}

Property values

managementGroups

Name Description Value
type The resource type 'Microsoft.Management/managementGroups'
apiVersion The resource api version '2020-10-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 JSON: /.
properties The generic properties of a management group used during creation. CreateManagementGroupPropertiesOrManagementGroupProp...

CreateManagementGroupPropertiesOrManagementGroupProp...

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

CreateManagementGroupDetailsOrManagementGroupDetails

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

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a New Management Group

Deploy to Azure
This template is a tenant level template that will create a new management group.

Terraform (AzAPI provider) resource definition

The managementGroups resource type is an extension resource, which means you can apply it to another resource.

Use the parent_id property on this resource to set the scope for this resource.

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

  • Tenants

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

Property values

managementGroups

Name Description Value
type The resource type "Microsoft.Management/managementGroups@2020-10-01"
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties The generic properties of a management group used during creation. CreateManagementGroupPropertiesOrManagementGroupProp...

CreateManagementGroupPropertiesOrManagementGroupProp...

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

CreateManagementGroupDetailsOrManagementGroupDetails

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

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