Microsoft.Management/managementGroups 2020-02-01 – Bicep, ARM template & Terraform AzAPI reference

Table of Contents0.1 In this article1 Bicep resource definition2 Remarks3 Resource format4 Property values4.1 managementGroups4.2 CreateManagementGroupPropertiesOrManagementGroupProperties4.3 CreateManagementGroupDetailsOrManagementGroupDetails4.4 CreateParentGroupInfoOrParentGroupInfo5 Quickstart templates6 ARM template resource definition7 Remarks8 Resource format9 Property values9.1 managementGroups9.2 CreateManagementGroupPropertiesOrManagementGroupProperties9.3 CreateManagementGroupDetailsOrManagementGroupDetails9.4 CreateParentGroupInfoOrParentGroupInfo10 Quickstart templates11 Terraform (AzAPI provider) resource definition12 Resource format13 Property values13.1 managementGroups13.2 CreateManagementGroupPropertiesOrManagementGroupProperties13.3 CreateManagementGroupDetailsOrManagementGroupDetails13.4 CreateParentGroupInfoOrParentGroupInfo […]

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.

Valid deployment scopes for the managementGroups resource are:

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/[email protected]' = {
  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…

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

CreateManagementGroupDetailsOrManagementGroupDetails

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.

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.

Valid deployment scopes for the managementGroups resource are:

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-02-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-02-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…

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

CreateManagementGroupDetailsOrManagementGroupDetails

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.

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.

Valid deployment scopes for the managementGroups resource are:

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/[email protected]"
  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/[email protected]
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…

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

CreateManagementGroupDetailsOrManagementGroupDetails

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

Source Article

Next Post

Microsoft.ApiManagement/service/contentTypes/contentItems 2021-12-01-preview - Bicep, ARM template & Terraform AzAPI reference

Wed Sep 28 , 2022
Table of Contents0.1 In this article1 Bicep resource definition2 Resource format3 Property values3.1 service/contentTypes/contentItems4 ARM template resource definition5 Resource format6 Property values6.1 service/contentTypes/contentItems7 Terraform (AzAPI provider) resource definition8 Resource format9 Property values9.1 service/contentTypes/contentItems Article 09/02/2022 2 minutes to read 1 contributor […]