Microsoft.Management (stable:2023-04-01)

2025/12/12 • 20 updated methods

CheckNameAvailability (updated)
Description :  Checks if the specified management group name is valid and unique
Reference :  Link ¶

⚶ Changes

{
  "#id": "CheckNameAvailability",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    },
    {
      "#name": "checkNameAvailabilityRequest",
      "Description": {
        "new": "The request body",
        "old": "Management group name availability check parameters."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "reason",
          "Enum": {
            "new": [
              [
                "Invalid",
                "Invalid"
              ],
              [
                "AlreadyExists",
                "AlreadyExists"
              ]
            ],
            "old": [
              [
                "Invalid",
                ""
              ],
              [
                "AlreadyExists",
                ""
              ]
            ]
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_47e2531a3c2d4858a51ee6b8ebdb378f": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_8e3a0b9623f445a49e70a88782b022db": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Management/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: the name to check for availability ,
Required: False ,
}
string ,
type:
{
Description: fully qualified resource type which includes provider namespace ,
Enum:
{
Microsoft.Management/managementGroups: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both. ,
Required: False ,
}
boolean ,
reason:
{
Description: Required if nameAvailable == false. Invalid indicates the name provided does not match the resource provider's naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Invalid: Invalid ,
AlreadyExists: AlreadyExists ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Required if nameAvailable == false. Localized. If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Entities_List (updated)
Description :  List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Entities_List",
  "Description": {
    "new": "List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.",
    "old": "List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    },
    {
      "#name": "$skiptoken",
      "Description": {
        "new": "Page continuation token is only used if a previous operation returned a partial result.\nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.",
        "old": "Page continuation token is only used if a previous operation returned a partial result. \nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.\n"
      }
    },
    {
      "#name": "$search",
      "Description": {
        "new": "The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in.\nWith $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions.\nWith $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity.\nWith $search=ParentAndFirstLevelChildren the API will return the parent and  first level of children that the user has either direct access to or indirect access via one of their descendants.\nWith $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group.\nWith $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter.  The user must have direct access to the children entities or one of it's descendants for it to show up in the results.",
        "old": "The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. \nWith $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions.\nWith $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity.\nWith $search=ParentAndFirstLevelChildren the API will return the parent and  first level of children that the user has either direct access to or indirect access via one of their descendants.\nWith $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group.\nWith $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter.  The user must have direct access to the children entities or one of it's descendants for it to show up in the results."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The EntityInfo items on this page",
            "old": "The list of entities."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "permissions",
                  "Enum": {
                    "new": [
                      [
                        "noaccess",
                        "noaccess"
                      ],
                      [
                        "view",
                        "view"
                      ],
                      [
                        "edit",
                        "edit"
                      ],
                      [
                        "delete",
                        "delete"
                      ]
                    ],
                    "old": [
                      [
                        "noaccess",
                        ""
                      ],
                      [
                        "view",
                        ""
                      ],
                      [
                        "edit",
                        ""
                      ],
                      [
                        "delete",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "inheritedPermissions",
                  "Enum": {
                    "new": [
                      [
                        "noaccess",
                        "noaccess"
                      ],
                      [
                        "view",
                        "view"
                      ],
                      [
                        "edit",
                        "edit"
                      ],
                      [
                        "delete",
                        "delete"
                      ]
                    ],
                    "old": [
                      [
                        "noaccess",
                        ""
                      ],
                      [
                        "view",
                        ""
                      ],
                      [
                        "edit",
                        ""
                      ],
                      [
                        "delete",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL to use for getting the next set of results."
          }
        },
        {
          "#name": "count",
          "Description": {
            "new": "Total count of records that match the filter.",
            "old": "Total count of records that match the filter"
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_b0951d26d91d480489b72895c6107956": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_5c916588f6f04a7bad28a05e2fadf4b1": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Management/getEntities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
$skip:
{
Description: Number of entities to skip over when retrieving results. Passing this in will override $skipToken. ,
Format: int32 ,
Required: False ,
}
integer ,
$top:
{
Description: Number of elements to return when retrieving results. Passing this in will override $skipToken. ,
Format: int32 ,
Required: False ,
}
integer ,
$select:
{
Description: This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken. ,
Required: False ,
}
string ,
$search:
{
Description: The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results. ,
Required: False ,
}
string ,
$filter:
{
Description: The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively. ,
Required: False ,
}
string ,
$view:
{
Description: The view parameter allows clients to filter the type of data that is returned by the getEntities call. ,
Required: False ,
}
string ,
groupName:
{
Description: A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'") ,
Required: False ,
}
string ,
Cache-Control:
{
Description: Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EntityInfo items on this page ,
Required: True ,
}
[
{
id:
{
Description: The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. For example, Microsoft.Management/managementGroups ,
Required: False ,
}
string ,
name:
{
Description: The name of the entity. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
properties:
{
Description: The generic properties of an entity. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
parent:
{
Description: (Optional) The ID of the parent management group. ,
Required: False ,
}
{
id:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
}
,
permissions:
{
Description: The users specific permissions to this item. ,
Enum:
{
noaccess: noaccess ,
view: view ,
edit: edit ,
delete: delete ,
}
,
Required: False ,
}
enum ,
inheritedPermissions:
{
Description: The users specific permissions to this item. ,
Enum:
{
noaccess: noaccess ,
view: view ,
edit: edit ,
delete: delete ,
}
,
Required: False ,
}
enum ,
numberOfDescendants:
{
Description: Number of Descendants ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChildren:
{
Description: Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group. ,
Format: int32 ,
Required: False ,
}
integer ,
numberOfChildGroups:
{
Description: Number of children is the number of Groups that are exactly one level underneath the current Group. ,
Format: int32 ,
Required: False ,
}
integer ,
parentDisplayNameChain:
{
Description: The parent display name chain from the root group to the immediate parent ,
Required: False ,
}
[
string ,
]
,
parentNameChain:
{
Description: The parent name chain from the root group to the immediate parent ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
count:
{
Description: Total count of records that match the filter. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementGroups_List (updated)
Description :  List management groups for the authenticated user.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementGroups_List",
  "Description": {
    "new": "List management groups for the authenticated user.",
    "old": "List management groups for the authenticated user.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    },
    {
      "#name": "$skiptoken",
      "Description": {
        "new": "Page continuation token is only used if a previous operation returned a partial result.\nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.",
        "old": "Page continuation token is only used if a previous operation returned a partial result. \nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.\n"
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_d4cd4c32e0d54a17a5d183d787c93a50": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_0ba433cf1c944c4cb033c97373a6d064": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of management groups. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. For example, Microsoft.Management/managementGroups ,
Required: False ,
}
string ,
name:
{
Description: The name of the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
properties:
{
Description: The generic properties of a management group. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
}
,
}
,
]
,
@nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementGroups_Get (updated)
Description :  Get the details of the management group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementGroups_Get",
  "Description": {
    "new": "Get the details of the management group.",
    "old": "Get the details of the management group.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "details": [
              {
                "#name": "version",
                "Type": {
                  "new": "integer",
                  "old": "number"
                }
              }
            ]
          },
          {
            "children": {
              "$properties": [
                {
                  "#name": "type",
                  "Enum": {
                    "new": [
                      [
                        "Microsoft.Management/managementGroups",
                        "Microsoft.Management/managementGroups"
                      ],
                      [
                        "/subscriptions",
                        "/subscriptions"
                      ]
                    ],
                    "old": [
                      [
                        "Microsoft.Management/managementGroups",
                        ""
                      ],
                      [
                        "/subscriptions",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ],
        "@removed_3fde3ce5b7784dd4853382e81412c849": {
          "#name": "id",
          "Description": "The fully qualified ID for the management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000",
          "Required": false,
          "Type": "string"
        },
        "@removed_5aeb062d454346c896b6779fa997ab8a": {
          "#name": "type",
          "Description": "The type of the resource.  For example, Microsoft.Management/managementGroups",
          "Required": false,
          "Type": "string"
        },
        "@removed_7c00ae8057e1410a8e3d04a437586835": {
          "#name": "name",
          "Description": "The name of the management group. For example, 00000000-0000-0000-0000-000000000000",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_4123a4b6e20545d99ad16d050a3b1632": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_a88ea1432be741819301b6631b9d8e14": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
$expand:
{
Description: The $expand=children query string parameter allows clients to request inclusion of children in the response payload. $expand=path includes the path from the root group to the current group. $expand=ancestors includes the ancestor Ids of the current group. ,
Required: False ,
}
string ,
$recurse:
{
Description: The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true. ,
Required: False ,
}
boolean ,
$filter:
{
Description: A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription') ,
Required: False ,
}
string ,
Cache-Control:
{
Description: Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The generic properties of a management group. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
details:
{
Description: The details of a management group. ,
Required: False ,
}
{
version:
{
Description: The version number of the object. ,
Format: int32 ,
Required: False ,
}
integer ,
updatedTime:
{
Description: The date and time when this object was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
updatedBy:
{
Description: The identity of the principal or process that updated the object. ,
Required: False ,
}
string ,
parent:
{
Description: (Optional) The ID of the parent management group. ,
Required: False ,
}
{
id:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
name:
{
Description: The name of the parent management group ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the parent management group. ,
Required: False ,
}
string ,
}
,
path:
{
Description: The path from the root to the current group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the group. ,
Required: False ,
}
string ,
}
,
]
,
managementGroupAncestors:
{
Description: The ancestors of the management group. ,
Required: False ,
}
[
string ,
]
,
managementGroupAncestorsChain:
{
Description: The ancestors of the management group displayed in reversed order, from immediate parent to the root. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
type:
{
Description: The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups) ,
Enum:
{
Microsoft.Management/managementGroups: Microsoft.Management/managementGroups ,
/subscriptions: /subscriptions ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
name:
{
Description: The name of the child entity. ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the child resource. ,
Required: False ,
}
string ,
children:
{
Description: The list of children. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementGroups_CreateOrUpdate (updated)
Description :  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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementGroups_CreateOrUpdate",
  "Description": {
    "new": "Create or update a management group.\nIf a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.",
    "old": "Create or update a management group.\nIf a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    },
    {
      "createManagementGroupRequest": {
        "$properties": {
          "properties": [
            {
              "details": [
                {
                  "#name": "version",
                  "Type": {
                    "new": "integer",
                    "old": "number"
                  }
                }
              ]
            },
            {
              "children": {
                "$properties": [
                  {
                    "#name": "type",
                    "Enum": {
                      "new": [
                        [
                          "Microsoft.Management/managementGroups",
                          "Microsoft.Management/managementGroups"
                        ],
                        [
                          "/subscriptions",
                          "/subscriptions"
                        ]
                      ],
                      "old": [
                        [
                          "Microsoft.Management/managementGroups",
                          ""
                        ],
                        [
                          "/subscriptions",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "details": [
              {
                "#name": "version",
                "Type": {
                  "new": "integer",
                  "old": "number"
                }
              }
            ]
          },
          {
            "children": {
              "$properties": [
                {
                  "#name": "type",
                  "Enum": {
                    "new": [
                      [
                        "Microsoft.Management/managementGroups",
                        "Microsoft.Management/managementGroups"
                      ],
                      [
                        "/subscriptions",
                        "/subscriptions"
                      ]
                    ],
                    "old": [
                      [
                        "Microsoft.Management/managementGroups",
                        ""
                      ],
                      [
                        "/subscriptions",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ],
        "@removed_36aa03e535db42daaed0d114940f939c": {
          "#name": "id",
          "Description": "The fully qualified ID for the management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000",
          "Required": false,
          "Type": "string"
        },
        "@removed_95862fc96ff6429a920c14c5acef783c": {
          "#name": "type",
          "Description": "The type of the resource.  For example, Microsoft.Management/managementGroups",
          "Required": false,
          "Type": "string"
        },
        "@removed_d81cf7232a5743d98978442158c67295": {
          "#name": "name",
          "Description": "The name of the management group. For example, 00000000-0000-0000-0000-000000000000",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers"
        }
      }
    ],
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_f63a3fbafaf2405f876b6adf35f1729d": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_632437c7cd844af6a468112ae5c05d39": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{groupId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. ,
Required: False ,
}
string ,
createManagementGroupRequest:
{
Description: Management group creation parameters. ,
Required: True ,
}
{
id:
{
Description: The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. For example, Microsoft.Management/managementGroups ,
Required: False ,
}
string ,
name:
{
Description: The name of the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
properties:
{
Description: The generic properties of a management group used during creation. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. If no value is passed then this field will be set to the groupId. ,
Required: False ,
}
string ,
details:
{
Description: The details of a management group used during creation. ,
Required: False ,
}
{
version:
{
Description: The version number of the object. ,
Format: int32 ,
Required: False ,
}
integer ,
updatedTime:
{
Description: The date and time when this object was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
updatedBy:
{
Description: The identity of the principal or process that updated the object. ,
Required: False ,
}
string ,
parent:
{
Description: (Optional) The ID of the parent management group used during creation. ,
Required: False ,
}
{
id:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
name:
{
Description: The name of the parent management group ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the parent management group. ,
Required: False ,
}
string ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
type:
{
Description: The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups) ,
Enum:
{
Microsoft.Management/managementGroups: Microsoft.Management/managementGroups ,
/subscriptions: /subscriptions ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
name:
{
Description: The name of the child entity. ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the child resource. ,
Required: False ,
}
string ,
children:
{
Description: The list of children. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The generic properties of a management group. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
details:
{
Description: The details of a management group. ,
Required: False ,
}
{
version:
{
Description: The version number of the object. ,
Format: int32 ,
Required: False ,
}
integer ,
updatedTime:
{
Description: The date and time when this object was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
updatedBy:
{
Description: The identity of the principal or process that updated the object. ,
Required: False ,
}
string ,
parent:
{
Description: (Optional) The ID of the parent management group. ,
Required: False ,
}
{
id:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
name:
{
Description: The name of the parent management group ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the parent management group. ,
Required: False ,
}
string ,
}
,
path:
{
Description: The path from the root to the current group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the group. ,
Required: False ,
}
string ,
}
,
]
,
managementGroupAncestors:
{
Description: The ancestors of the management group. ,
Required: False ,
}
[
string ,
]
,
managementGroupAncestorsChain:
{
Description: The ancestors of the management group displayed in reversed order, from immediate parent to the root. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
type:
{
Description: The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups) ,
Enum:
{
Microsoft.Management/managementGroups: Microsoft.Management/managementGroups ,
/subscriptions: /subscriptions ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
name:
{
Description: The name of the child entity. ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the child resource. ,
Required: False ,
}
string ,
children:
{
Description: The list of children. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}
,
$schema:
{
Description: The results of Azure-AsyncOperation. ,
}
{
id:
{
Description: The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. For example, Microsoft.Management/managementGroups ,
Required: False ,
}
string ,
name:
{
Description: The name of the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
status:
{
Description: The current status of the asynchronous operation performed . For example, Running, Succeeded, Failed ,
Required: False ,
}
string ,
properties:
{
Description: The generic properties of a management group. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementGroups_Update (updated)
Description :  Update a management group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementGroups_Update",
  "Description": {
    "new": "Update a management group.",
    "old": "Update a management group.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "details": [
              {
                "#name": "version",
                "Type": {
                  "new": "integer",
                  "old": "number"
                }
              }
            ]
          },
          {
            "children": {
              "$properties": [
                {
                  "#name": "type",
                  "Enum": {
                    "new": [
                      [
                        "Microsoft.Management/managementGroups",
                        "Microsoft.Management/managementGroups"
                      ],
                      [
                        "/subscriptions",
                        "/subscriptions"
                      ]
                    ],
                    "old": [
                      [
                        "Microsoft.Management/managementGroups",
                        ""
                      ],
                      [
                        "/subscriptions",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ],
        "@removed_5bd4aaedb1614474b09f3cec7da34554": {
          "#name": "id",
          "Description": "The fully qualified ID for the management group.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000",
          "Required": false,
          "Type": "string"
        },
        "@removed_3bf17a94133047db851b8cdc7285b9f3": {
          "#name": "type",
          "Description": "The type of the resource.  For example, Microsoft.Management/managementGroups",
          "Required": false,
          "Type": "string"
        },
        "@removed_54539f1832184d458f98a76eddadfc45": {
          "#name": "name",
          "Description": "The name of the management group. For example, 00000000-0000-0000-0000-000000000000",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_53e723810042475d835541149e10ee4c": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_d42950286f0f4e9c89453c52d3285cf3": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{groupId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. ,
Required: False ,
}
string ,
patchGroupRequest:
{
Description: Management group patch parameters. ,
Required: True ,
}
{
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
parentGroupId:
{
Description: (Optional) The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The generic properties of a management group. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
details:
{
Description: The details of a management group. ,
Required: False ,
}
{
version:
{
Description: The version number of the object. ,
Format: int32 ,
Required: False ,
}
integer ,
updatedTime:
{
Description: The date and time when this object was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
updatedBy:
{
Description: The identity of the principal or process that updated the object. ,
Required: False ,
}
string ,
parent:
{
Description: (Optional) The ID of the parent management group. ,
Required: False ,
}
{
id:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
name:
{
Description: The name of the parent management group ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the parent management group. ,
Required: False ,
}
string ,
}
,
path:
{
Description: The path from the root to the current group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the group. ,
Required: False ,
}
string ,
}
,
]
,
managementGroupAncestors:
{
Description: The ancestors of the management group. ,
Required: False ,
}
[
string ,
]
,
managementGroupAncestorsChain:
{
Description: The ancestors of the management group displayed in reversed order, from immediate parent to the root. ,
Required: False ,
}
[
{
name:
{
Description: The name of the group. ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the group. ,
Required: False ,
}
string ,
}
,
]
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
type:
{
Description: The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups) ,
Enum:
{
Microsoft.Management/managementGroups: Microsoft.Management/managementGroups ,
/subscriptions: /subscriptions ,
}
,
Required: False ,
}
enum ,
id:
{
Description: The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
name:
{
Description: The name of the child entity. ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the child resource. ,
Required: False ,
}
string ,
children:
{
Description: The list of children. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementGroups_Delete (updated)
Description :  Delete management group. If a management group contains child resources, the request will fail.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementGroups_Delete",
  "Description": {
    "new": "Delete management group.\nIf a management group contains child resources, the request will fail.",
    "old": "Delete management group.\nIf a management group contains child resources, the request will fail.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "azure-asyncoperation",
        "Description": {
          "new": "A link to the status monitor",
          "old": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations"
        }
      },
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers"
        }
      },
      {
        "@added_05eaf6771fba41a2b77e390c3d84ac22": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_9d3ec5fe92d5466180ea58f53fd5c078": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_6e96aa7d50574b6085dc7d9c8824427c": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{groupId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The results of Azure-AsyncOperation. ,
}
{
id:
{
Description: The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. For example, Microsoft.Management/managementGroups ,
Required: False ,
}
string ,
name:
{
Description: The name of the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
status:
{
Description: The current status of the asynchronous operation performed . For example, Running, Succeeded, Failed ,
Required: False ,
}
string ,
properties:
{
Description: The generic properties of a management group. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementGroups_GetDescendants (updated)
Description :  List all entities that descend from a management group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementGroups_GetDescendants",
  "Description": {
    "new": "List all entities that descend from a management group.",
    "old": "List all entities that descend from a management group.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    },
    {
      "#name": "$skiptoken",
      "Description": {
        "new": "Page continuation token is only used if a previous operation returned a partial result.\nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.",
        "old": "Page continuation token is only used if a previous operation returned a partial result. \nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.\n"
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Paged collection of DescendantInfo items",
        "old": "Describes the result of the request to view descendants."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The DescendantInfo items on this page",
            "old": "The list of descendants."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL to use for getting the next set of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_1dd60bd5d0d547a19f84ec3727f29dc6": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_93001b4af6154d729c6b60a205a22e19": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/descendants
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
$top:
{
Description: Number of elements to return when retrieving results. Passing this in will override $skipToken. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The DescendantInfo items on this page ,
Required: True ,
}
[
{
id:
{
Description: The fully qualified ID for the descendant. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 or /subscriptions/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. For example, Microsoft.Management/managementGroups or /subscriptions ,
Required: False ,
}
string ,
name:
{
Description: The name of the descendant. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
properties:
{
Description: The generic properties of an descendant. ,
Required: False ,
}
{
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
parent:
{
Description: The ID of the parent management group. ,
Required: False ,
}
{
id:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HierarchySettings_List (updated)
Description :  Gets all the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.
Reference :  Link ¶

⚶ Changes

{
  "#id": "HierarchySettings_List",
  "Description": {
    "new": "Gets all the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.",
    "old": "Gets all the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_ac7a6999ed2544429e712f4de7c71222": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_8187fe07193243f588fb81014ba0203e": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/settings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hierarchy settings. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. For example, Microsoft.Management/managementGroups/settings. ,
Required: False ,
}
string ,
name:
{
Description: The name of the object. In this case, default. ,
Required: False ,
}
string ,
properties:
{
Description: The generic properties of hierarchy settings. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
requireAuthorizationForGroupCreation:
{
Description: 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. ,
Required: False ,
}
boolean ,
defaultManagementGroup:
{
Description: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup ,
Required: False ,
}
string ,
}
,
}
,
]
,
@nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HierarchySettings_Get (updated)
Description :  Gets the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.
Reference :  Link ¶

⚶ Changes

{
  "#id": "HierarchySettings_Get",
  "Description": {
    "new": "Gets the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.",
    "old": "Gets the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_af6a425298644c9791107d5bd8fcc11d": {
          "#name": "id",
          "Description": "The fully qualified ID for the settings object.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.",
          "Required": false,
          "Type": "string"
        },
        "@removed_190964b045cf456da84b81c8ffefa903": {
          "#name": "type",
          "Description": "The type of the resource.  For example, Microsoft.Management/managementGroups/settings.",
          "Required": false,
          "Type": "string"
        },
        "@removed_ed0f7191e4d64bbf9500f8f07fb06e7c": {
          "#name": "name",
          "Description": "The name of the object. In this case, default.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_ebde24b6a1a2477e981c953d7f452773": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_130b4e8c46b048f7acd7d2ec6f455dfe": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/settings/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The generic properties of hierarchy settings. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
requireAuthorizationForGroupCreation:
{
Description: 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. ,
Required: False ,
}
boolean ,
defaultManagementGroup:
{
Description: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HierarchySettings_CreateOrUpdate (updated)
Description :  Creates or updates the hierarchy settings defined at the Management Group level.
Reference :  Link ¶

⚶ Changes

{
  "#id": "HierarchySettings_CreateOrUpdate",
  "Description": {
    "new": "Creates or updates the hierarchy settings defined at the Management Group level.",
    "old": "Creates or updates the hierarchy settings defined at the Management Group level.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_2d153d1a40584f2a9eb15fe65e1157cd": {
          "#name": "id",
          "Description": "The fully qualified ID for the settings object.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.",
          "Required": false,
          "Type": "string"
        },
        "@removed_47f1f09ddc1f4ee9bd846c77bd4e1c3e": {
          "#name": "type",
          "Description": "The type of the resource.  For example, Microsoft.Management/managementGroups/settings.",
          "Required": false,
          "Type": "string"
        },
        "@removed_50240220b30e4e90a6953c5a04797da4": {
          "#name": "name",
          "Description": "The name of the object. In this case, default.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_1a60417bcbd942caac2868ff17dcafad": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_a1f80e3f682e4dae8a8b65352f7e47f7": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{groupId}/settings/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
CreateTenantSettingsRequest:
{
Description: Tenant level settings request parameter. ,
Required: True ,
}
{
properties:
{
Description: The properties of the request to create or update Management Group settings ,
Required: False ,
}
{
requireAuthorizationForGroupCreation:
{
Description: 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. ,
Required: False ,
}
boolean ,
defaultManagementGroup:
{
Description: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The generic properties of hierarchy settings. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
requireAuthorizationForGroupCreation:
{
Description: 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. ,
Required: False ,
}
boolean ,
defaultManagementGroup:
{
Description: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HierarchySettings_Update (updated)
Description :  Updates the hierarchy settings defined at the Management Group level.
Reference :  Link ¶

⚶ Changes

{
  "#id": "HierarchySettings_Update",
  "Description": {
    "new": "Updates the hierarchy settings defined at the Management Group level.",
    "old": "Updates the hierarchy settings defined at the Management Group level.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_93d4fd2cf8ed44d298eb42eb36d9526d": {
          "#name": "id",
          "Description": "The fully qualified ID for the settings object.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.",
          "Required": false,
          "Type": "string"
        },
        "@removed_b6732a2f789e4a5fadc6732accc4f9d8": {
          "#name": "type",
          "Description": "The type of the resource.  For example, Microsoft.Management/managementGroups/settings.",
          "Required": false,
          "Type": "string"
        },
        "@removed_c8347416c0b44bbd9f3c6564c66ebb3e": {
          "#name": "name",
          "Description": "The name of the object. In this case, default.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_f71faf9fd65746658b01217b957da08f": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_f4ca21cbf35a4673969de1837c4f665f": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{groupId}/settings/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
CreateTenantSettingsRequest:
{
Description: Tenant level settings request parameter. ,
Required: True ,
}
{
properties:
{
Description: The properties of the request to create or update Management Group settings ,
Required: False ,
}
{
requireAuthorizationForGroupCreation:
{
Description: 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. ,
Required: False ,
}
boolean ,
defaultManagementGroup:
{
Description: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The generic properties of hierarchy settings. ,
Required: False ,
}
{
tenantId:
{
Description: The AAD Tenant ID associated with the hierarchy settings. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
requireAuthorizationForGroupCreation:
{
Description: 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. ,
Required: False ,
}
boolean ,
defaultManagementGroup:
{
Description: Settings that sets the default Management Group under which new subscriptions get added in this tenant. For example, /providers/Microsoft.Management/managementGroups/defaultGroup ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HierarchySettings_Delete (updated)
Description :  Deletes the hierarchy settings defined at the Management Group level.
Reference :  Link ¶

⚶ Changes

{
  "#id": "HierarchySettings_Delete",
  "Description": {
    "new": "Deletes the hierarchy settings defined at the Management Group level.",
    "old": "Deletes the hierarchy settings defined at the Management Group level.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_8b5eb736001344aa90315b1212dff29b": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_8bc1628b79394cc0a5aa1f870c56c79b": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{groupId}/settings/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementGroupSubscriptions_GetSubscriptionsUnderManagementGroup (updated)
Description :  Retrieves details about all subscriptions which are associated with the management group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementGroupSubscriptions_GetSubscriptionsUnderManagementGroup",
  "Description": {
    "new": "Retrieves details about all subscriptions which are associated with the management group.",
    "old": "Retrieves details about all subscriptions which are associated with the management group.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    },
    {
      "#name": "$skiptoken",
      "Description": {
        "new": "Page continuation token is only used if a previous operation returned a partial result.\nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.",
        "old": "Page continuation token is only used if a previous operation returned a partial result. \nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.\n"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SubscriptionUnderManagementGroup items on this page",
            "old": "The list of subscriptions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_deb8f21847f449198d66bea912a5d003": {
                "#name": "id",
                "Description": "The fully qualified ID for the subscription.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/subscriptions/0000000-0000-0000-0000-000000000001",
                "Required": false,
                "Type": "string"
              },
              "@removed_5d8864353f2442898decdb0d18600bb1": {
                "#name": "type",
                "Description": "The type of the resource.  For example, Microsoft.Management/managementGroups/subscriptions",
                "Required": false,
                "Type": "string"
              },
              "@removed_008f372660784098af8c4a685bb507c4": {
                "#name": "name",
                "Description": "The stringified id of the subscription. For example, 00000000-0000-0000-0000-000000000000",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The URL to use for getting the next set of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_425d3a7547904134b8d4909ef37c291d": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_2c91c712886c4e3095d58dc3062a3a4f": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
$skiptoken:
{
Description: Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SubscriptionUnderManagementGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The generic properties of subscription under a management group. ,
Required: False ,
}
{
tenant:
{
Description: The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the subscription. ,
Required: False ,
}
string ,
parent:
{
Description: The ID of the parent management group. ,
Required: False ,
}
{
id:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
}
,
state:
{
Description: The state of the subscription. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementGroupSubscriptions_GetSubscription (updated)
Description :  Retrieves details about given subscription which is associated with the management group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementGroupSubscriptions_GetSubscription",
  "Description": {
    "new": "Retrieves details about given subscription which is associated with the management group.",
    "old": "Retrieves details about given subscription which is associated with the management group.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_73a92018454a4bb1928a04c3b16721e0": {
          "#name": "id",
          "Description": "The fully qualified ID for the subscription.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/subscriptions/0000000-0000-0000-0000-000000000001",
          "Required": false,
          "Type": "string"
        },
        "@removed_682cc9e16e0c4d4fbc886d07c60980ad": {
          "#name": "type",
          "Description": "The type of the resource.  For example, Microsoft.Management/managementGroups/subscriptions",
          "Required": false,
          "Type": "string"
        },
        "@removed_975fabb4edc04f06b2010283d2ee02d7": {
          "#name": "name",
          "Description": "The stringified id of the subscription. For example, 00000000-0000-0000-0000-000000000000",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_7197f425d2e04d6392dc24d44ba6a419": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_29c48b2609414ad0889a80aba30f5092": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The generic properties of subscription under a management group. ,
Required: False ,
}
{
tenant:
{
Description: The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the subscription. ,
Required: False ,
}
string ,
parent:
{
Description: The ID of the parent management group. ,
Required: False ,
}
{
id:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
}
,
state:
{
Description: The state of the subscription. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementGroupSubscriptions_Create (updated)
Description :  Associates existing subscription with the management group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementGroupSubscriptions_Create",
  "Description": {
    "new": "Associates existing subscription with the management group.",
    "old": "Associates existing subscription with the management group.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_bda4f4e372c84753a8a7610594c52c88": {
          "#name": "id",
          "Description": "The fully qualified ID for the subscription.  For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/subscriptions/0000000-0000-0000-0000-000000000001",
          "Required": false,
          "Type": "string"
        },
        "@removed_be603fee6641462fbd0d5541f7b1efd6": {
          "#name": "type",
          "Description": "The type of the resource.  For example, Microsoft.Management/managementGroups/subscriptions",
          "Required": false,
          "Type": "string"
        },
        "@removed_cea6e39aa357474db6acb2d9e388e706": {
          "#name": "name",
          "Description": "The stringified id of the subscription. For example, 00000000-0000-0000-0000-000000000000",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_174a7486a2ba40b3b030c7c79bf0897c": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_abae681a874542a9a29bd8e3f1dd0bb3": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The generic properties of subscription under a management group. ,
Required: False ,
}
{
tenant:
{
Description: The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the subscription. ,
Required: False ,
}
string ,
parent:
{
Description: The ID of the parent management group. ,
Required: False ,
}
{
id:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
}
,
state:
{
Description: The state of the subscription. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ManagementGroupSubscriptions_Delete (updated)
Description :  De-associates subscription from the management group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ManagementGroupSubscriptions_Delete",
  "Description": {
    "new": "De-associates subscription from the management group.",
    "old": "De-associates subscription from the management group.\n"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_4341d40ae7f34870a241f730560ac6d5": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_75a2e5a4f9af4222966e54268f787920": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates whether the request should utilize any caches. Populate the header with 'no-cache' value to bypass existing caches. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists all of the available Management REST API operations."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.",
        "old": "Describes the result of the request to list Microsoft.Management operations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "List of operations supported by the resource provider",
            "old": "List of operations supported by the Microsoft.Management resource provider."
          },
          "$items": {
            "Description": {
              "new": "Details of a REST API operation, returned from the Resource Provider Operations API",
              "old": "Operation supported by the Microsoft.Management resource provider."
            },
            "$properties": [
              {
                "#name": "name",
                "Description": {
                  "new": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"",
                  "old": "Operation name: {provider}/{resource}/{operation}."
                }
              },
              {
                "@added_8d0e435b212e491faee52c02f5a72cad": {
                  "#name": "isDataAction",
                  "Description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.",
                  "Required": false,
                  "Type": "boolean"
                }
              },
              {
                "#name": "display",
                "Description": {
                  "new": "Localized display information for this particular operation.",
                  "old": "The object that represents the operation."
                },
                "$properties": [
                  {
                    "#name": "provider",
                    "Description": {
                      "new": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".",
                      "old": "The name of the provider."
                    }
                  },
                  {
                    "#name": "resource",
                    "Description": {
                      "new": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".",
                      "old": "The resource on which the operation is performed."
                    }
                  },
                  {
                    "#name": "operation",
                    "Description": {
                      "new": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".",
                      "old": "The operation that can be performed."
                    }
                  },
                  {
                    "#name": "description",
                    "Description": {
                      "new": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.",
                      "old": "Operation description."
                    }
                  }
                ]
              },
              {
                "@added_799082f53d0d488990c1f1fafd42aebf": {
                  "#name": "origin",
                  "Description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"",
                  "Enum": [
                    [
                      "user",
                      ""
                    ],
                    [
                      "system",
                      ""
                    ],
                    [
                      "user,system",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@added_a8c0db34a3ec49d38decbfe88be88ac4": {
                  "#name": "actionType",
                  "Description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.",
                  "Enum": [
                    [
                      "Internal",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "URL to get the next set of operation list results (if there are any).",
            "old": "URL to get the next set of operation list results if there are any."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_3409a5169096483f894848a66a467461": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_142fc94ff9a248098044b5871cb271a7": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Management/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StartTenantBackfill (updated)
Description :  Starts backfilling subscriptions for the Tenant.
Reference :  Link ¶

⚶ Changes

{
  "#id": "StartTenantBackfill",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "status",
          "Enum": {
            "new": [
              [
                "NotStarted",
                "NotStarted"
              ],
              [
                "NotStartedButGroupsExist",
                "NotStartedButGroupsExist"
              ],
              [
                "Started",
                "Started"
              ],
              [
                "Failed",
                "Failed"
              ],
              [
                "Cancelled",
                "Cancelled"
              ],
              [
                "Completed",
                "Completed"
              ]
            ],
            "old": [
              [
                "NotStarted",
                ""
              ],
              [
                "NotStartedButGroupsExist",
                ""
              ],
              [
                "Started",
                ""
              ],
              [
                "Failed",
                ""
              ],
              [
                "Cancelled",
                ""
              ],
              [
                "Completed",
                ""
              ]
            ]
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_516a477fb1954acbaf50cea0c449a4f2": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_314ce5382ccd47db88dd31151bb4ae46": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Management/startTenantBackfill
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
status:
{
Description: The status of the Tenant Backfill ,
Enum:
{
NotStarted: NotStarted ,
NotStartedButGroupsExist: NotStartedButGroupsExist ,
Started: Started ,
Failed: Failed ,
Cancelled: Cancelled ,
Completed: Completed ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TenantBackfillStatus (updated)
Description :  Gets tenant backfill status
Reference :  Link ¶

⚶ Changes

{
  "#id": "TenantBackfillStatus",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Version of the API to be used with the client request. The current version is 2018-01-01-preview."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "status",
          "Enum": {
            "new": [
              [
                "NotStarted",
                "NotStarted"
              ],
              [
                "NotStartedButGroupsExist",
                "NotStartedButGroupsExist"
              ],
              [
                "Started",
                "Started"
              ],
              [
                "Failed",
                "Failed"
              ],
              [
                "Cancelled",
                "Cancelled"
              ],
              [
                "Completed",
                "Completed"
              ]
            ],
            "old": [
              [
                "NotStarted",
                ""
              ],
              [
                "NotStartedButGroupsExist",
                ""
              ],
              [
                "Started",
                ""
              ],
              [
                "Failed",
                ""
              ],
              [
                "Cancelled",
                ""
              ],
              [
                "Completed",
                ""
              ]
            ]
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "The details of the error."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "One of a server-defined set of error codes."
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "A human-readable representation of the error."
              }
            },
            {
              "@added_bd022cfc500346fe8c01f7465cca630e": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "details",
              "Description": {
                "new": "The error details.",
                "old": "A human-readable representation of the error's details."
              },
              "Type": {
                "new": "array",
                "old": "string"
              }
            },
            {
              "@added_710971ccee9c424b9fa15c6e58e35631": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Management/tenantBackfillStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
status:
{
Description: The status of the Tenant Backfill ,
Enum:
{
NotStarted: NotStarted ,
NotStartedButGroupsExist: NotStartedButGroupsExist ,
Started: Started ,
Failed: Failed ,
Cancelled: Cancelled ,
Completed: Completed ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}