Microsoft.Management managementGroups/settings

• Latest
• 2023-04-01
• 2021-04-01
• 2020-10-01
• 2020-05-01
• 2020-02-01

Bicep resource definition

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

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

Property Values

CreateOrUpdateSettingsPropertiesOrHierarchySettingsProperties

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

Microsoft.Management/managementGroups/settings

Name	Description	Value
name	The resource name	'default' (required)
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	CreateOrUpdateSettingsPropertiesOrHierarchySettingsProperties

ARM template resource definition

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

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

Property Values

CreateOrUpdateSettingsPropertiesOrHierarchySettingsProperties

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

Microsoft.Management/managementGroups/settings

Name	Description	Value
apiVersion	The api version	'2023-04-01'
name	The resource name	'default' (required)
properties	The properties of the request to create or update Management Group settings	CreateOrUpdateSettingsPropertiesOrHierarchySettingsProperties
type	The resource type	'Microsoft.Management/managementGroups/settings'

Usage Examples

Terraform (AzAPI provider) resource definition

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

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

Property Values

CreateOrUpdateSettingsPropertiesOrHierarchySettingsProperties

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

Microsoft.Management/managementGroups/settings

Name	Description	Value
name	The resource name	'default' (required)
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	CreateOrUpdateSettingsPropertiesOrHierarchySettingsProperties
type	The resource type	"Microsoft.Management/managementGroups/settings@2023-04-01"