Hierarchy Settings - Update

Reference

Service:: Management Groups

API Version:: 2020-05-01

Updates the hierarchy settings defined at the Management Group level.

PATCH https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/settings/default?api-version=2020-05-01

URI Parameters

Name	In	Required	Type	Description
groupId	path	True	string	Management Group ID.
api-version	query	True	string	Version of the API to be used with the client request. The current version is 2018-01-01-preview.

Request Body

Name	Type	Description
properties.defaultManagementGroup	string	Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
properties.requireAuthorizationForGroupCreation	boolean	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.

Responses

Name	Type	Description
200 OK	HierarchySettings	OK
Other Status Codes	ErrorResponse	Error

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

GetGroupSettings

Sample request

HTTP

PATCH https://management.azure.com/providers/Microsoft.Management/managementGroups/root/settings/default?api-version=2020-05-01

{
  "properties": {
    "defaultManagementGroup": "/providers/Microsoft.Management/managementGroups/DefaultGroup",
    "requireAuthorizationForGroupCreation": true
  }
}

Sample response

Status code:: 200

{
  "id": "/providers/Microsoft.Management/managementGroups/root/settings/default",
  "type": "Microsoft.Management/managementGroups/settings",
  "name": "root",
  "properties": {
    "tenantId": "20000000-0000-0000-0000-000000000000",
    "defaultManagementGroup": "/providers/Microsoft.Management/managementGroups/DefaultGroup",
    "requireAuthorizationForGroupCreation": true
  }
}

Definitions

Name	Description
CreateOrUpdateSettingsRequest	Parameters for creating or updating Management Group settings
ErrorDetails	The details of the error.
ErrorResponse	The error object.
HierarchySettings	Settings defined at the Management Group scope.

CreateOrUpdateSettingsRequest

Parameters for creating or updating Management Group settings

Name	Type	Description
properties.defaultManagementGroup	string	Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
properties.requireAuthorizationForGroupCreation	boolean	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.

ErrorDetails

The details of the error.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	string	A human-readable representation of the error's details.
message	string	A human-readable representation of the error.

ErrorResponse

The error object.

Name	Type	Description
error	ErrorDetails	Error The details of the error.

HierarchySettings

Settings defined at the Management Group scope.

Name	Type	Description
id	string	The fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
name	string	The name of the object. In this case, default.
properties.defaultManagementGroup	string	Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup
properties.requireAuthorizationForGroupCreation	boolean	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.
properties.tenantId	string	The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000
type	string	The type of the resource. For example, Microsoft.Management/managementGroups/settings.

Share via