Management Groups - Create Or Update

Service:: Management Groups

API Version:: 2020-05-01

Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}?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 Header

Name	Required	Type	Description
Cache-Control		string	Indicates that the request shouldn't utilize any caches.

Request Body

Name	Type	Description
name	string	The name of the management group. For example, 00000000-0000-0000-0000-000000000000
properties.details	CreateManagementGroupDetails	Details The details of a management group used during creation.
properties.displayName	string	The friendly name of the management group. If no value is passed then this field will be set to the groupId.

Responses

Name	Type	Description
200 OK	ManagementGroup	OK
202 Accepted	AzureAsyncOperationResults	Accepted Headers Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Error

Name

Type

Description

200 OK

ManagementGroup

202 Accepted

AzureAsyncOperationResults

Accepted

Headers

Location: string
Azure-AsyncOperation: string

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

PutManagementGroup

Sample request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/ChildGroup?api-version=2020-05-01


{
  "properties": {
    "displayName": "ChildGroup",
    "details": {
      "parent": {
        "id": "/providers/Microsoft.Management/managementGroups/RootGroup"
      }
    }
  }
}

Sample response

Status code:: 200

{
  "id": "/providers/Microsoft.Management/managementGroups/ChildGroup",
  "type": "Microsoft.Management/managementGroups",
  "name": "ChildGroup",
  "properties": {
    "tenantId": "20000000-0000-0000-0000-000000000000",
    "displayName": "ChildGroup",
    "details": {
      "version": 1,
      "updatedTime": "2018-01-01T00:00:00.00Z",
      "updatedBy": "16b8ef21-5c9f-420c-bcc9-e4f8c9f30b4b",
      "parent": {
        "id": "/providers/Microsoft.Management/managementGroups/RootGroup",
        "name": "RootGroup",
        "displayName": "RootGroup"
      }
    }
  }
}

Status code:: 202

{
  "id": "/providers/Microsoft.Management/managementGroups/ChildGroup",
  "type": "Microsoft.Management/managementGroups",
  "name": "ChildGroup",
  "status": "NotStarted"
}

Definitions

Name	Description
AzureAsyncOperationResults	The results of Azure-AsyncOperation.
CreateManagementGroupChildInfo	The child information of a management group used during creation.
CreateManagementGroupDetails	The details of a management group used during creation.
CreateManagementGroupRequest	Management group creation parameters.
CreateParentGroupInfo	(Optional) The ID of the parent management group used during creation.
ErrorDetails	The details of the error.
ErrorResponse	The error object.
ManagementGroup	The management group details.
ManagementGroupChildInfo	The child information of a management group.
ManagementGroupChildType	The type of child resource.
ManagementGroupDetails	The details of a management group.
ManagementGroupPathElement	A path element of a management group ancestors.
ParentGroupInfo	(Optional) The ID of the parent management group.

AzureAsyncOperationResults

Object

The results of Azure-AsyncOperation.

Name	Type	Description
id	string	The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	The name of the management group. For example, 00000000-0000-0000-0000-000000000000
properties.displayName	string	The friendly name of the management group.
properties.tenantId	string	The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
status	string	The current status of the asynchronous operation performed . For example, Running, Succeeded, Failed
type	string	The type of the resource. For example, Microsoft.Management/managementGroups

CreateManagementGroupChildInfo

Object

The child information of a management group used during creation.

Name	Type	Description
children	CreateManagementGroupChildInfo[]	The list of children.
displayName	string	The friendly name of the child resource.
id	string	The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	The name of the child entity.
type	ManagementGroupChildType	The type of child resource. The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups)

CreateManagementGroupDetails

Object

The details of a management group used during creation.

Name	Type	Description
parent	CreateParentGroupInfo	Parent (Optional) The ID of the parent management group used during creation.
updatedBy	string	The identity of the principal or process that updated the object.
updatedTime	string (date-time)	The date and time when this object was last updated.
version	number (int32)	The version number of the object.

CreateManagementGroupRequest

Object

Management group creation parameters.

Name	Type	Description
id	string	The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	The name of the management group. For example, 00000000-0000-0000-0000-000000000000
properties.children	CreateManagementGroupChildInfo[]	The list of children.
properties.details	CreateManagementGroupDetails	Details The details of a management group used during creation.
properties.displayName	string	The friendly name of the management group. If no value is passed then this field will be set to the groupId.
properties.tenantId	string	The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
type	string	The type of the resource. For example, Microsoft.Management/managementGroups

CreateParentGroupInfo

Object

(Optional) The ID of the parent management group used during creation.

Name	Type	Description
displayName	string	The friendly name of the parent management group.
id	string	The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	The name of the parent management group

ErrorDetails

Object

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

Object

The error object.

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