Share via

Microsoft.Management managementGroups/settings

  • Article

Bicep resource definition

The managementGroups/settings 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/settings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Management/managementGroups/settings@2021-04-01' = {
  name: 'default'
  parent: resourceSymbolicName
  properties: {
    defaultManagementGroup: 'string'
    requireAuthorizationForGroupCreation: bool
  }
}

Property values

managementGroups/settings

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 'default'
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: managementGroups
properties The properties of the request to create or update Management Group settings CreateOrUpdateSettingsPropertiesOrHierarchySettingsP...

CreateOrUpdateSettingsPropertiesOrHierarchySettingsP...

Name Description Value
defaultManagementGroup Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup string
requireAuthorizationForGroupCreation Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. bool

ARM template resource definition

The managementGroups/settings 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/settings resource, add the following JSON to your template.

{
  "type": "Microsoft.Management/managementGroups/settings",
  "apiVersion": "2021-04-01",
  "name": "default",
  "properties": {
    "defaultManagementGroup": "string",
    "requireAuthorizationForGroupCreation": "bool"
  }
}

Property values

managementGroups/settings

Name Description Value
type The resource type 'Microsoft.Management/managementGroups/settings'
apiVersion The resource api version '2021-04-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 'default'
properties The properties of the request to create or update Management Group settings CreateOrUpdateSettingsPropertiesOrHierarchySettingsP...

CreateOrUpdateSettingsPropertiesOrHierarchySettingsP...

Name Description Value
defaultManagementGroup Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup string
requireAuthorizationForGroupCreation Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. bool

Terraform (AzAPI provider) resource definition

The managementGroups/settings 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/settings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Management/managementGroups/settings@2021-04-01"
  name = "default"
  parent_id = "string"
  body = jsonencode({
    properties = {
      defaultManagementGroup = "string"
      requireAuthorizationForGroupCreation = bool
    }
  })
}

Property values

managementGroups/settings

Name Description Value
type The resource type "Microsoft.Management/managementGroups/settings@2021-04-01"
name The resource name "default"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: managementGroups
properties The properties of the request to create or update Management Group settings CreateOrUpdateSettingsPropertiesOrHierarchySettingsP...

CreateOrUpdateSettingsPropertiesOrHierarchySettingsP...

Name Description Value
defaultManagementGroup Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup string
requireAuthorizationForGroupCreation Indicates whether RBAC access is required upon group creation under the root Management Group. If set to true, user will require Microsoft.Management/managementGroups/write action on the root Management Group scope in order to create new Groups directly under the root. This will prevent new users from creating new Management Groups, unless they are given access. bool