Microsoft.Management (preview:2024-02-01)

2025/04/30 • 25 new methods

ManagementGroups_List (new)
Description :  List management groups for the authenticated user.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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 details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
ManagementGroups_Get (new)
Description :  Get the details of the management group.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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)

{
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 ,
details:
{
Description: The details of a management group. ,
Required: False ,
}
{
version:
{
Description: The version number of the object. ,
Format: int32 ,
Required: False ,
}
number ,
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: No description available. ,
/subscriptions: No description available. ,
}
,
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 details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
ManagementGroups_CreateOrUpdate (new)
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 ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{groupId}
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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 ,
}
number ,
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: No description available. ,
/subscriptions: No description available. ,
}
,
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)

{
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 ,
details:
{
Description: The details of a management group. ,
Required: False ,
}
{
version:
{
Description: The version number of the object. ,
Format: int32 ,
Required: False ,
}
number ,
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: No description available. ,
/subscriptions: No description available. ,
}
,
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:
{
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
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 details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
ManagementGroups_Update (new)
Description :  Update a management group.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{groupId}
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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)

{
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 ,
details:
{
Description: The details of a management group. ,
Required: False ,
}
{
version:
{
Description: The version number of the object. ,
Format: int32 ,
Required: False ,
}
number ,
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: No description available. ,
/subscriptions: No description available. ,
}
,
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 details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
ManagementGroups_Delete (new)
Description :  Delete management group. If a management group contains child resources, the request will fail.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{groupId}
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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:
{
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. The URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. For more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations ,
}
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 (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
ManagementGroups_GetDescendants (new)
Description :  List all entities that descend from a management group.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/descendants
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of descendants. ,
Required: False ,
}
[
{
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 URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
ManagementGroupSubscriptions_Create (new)
Description :  Associates existing subscription with the management group.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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)

{
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 ,
}
string ,
type:
{
Description: The type of the resource. For example, Microsoft.Management/managementGroups/subscriptions ,
Required: False ,
}
string ,
name:
{
Description: The stringified id of the subscription. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
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 details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
ManagementGroupSubscriptions_Delete (new)
Description :  De-associates subscription from the management group.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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 details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
ManagementGroupSubscriptions_GetSubscription (new)
Description :  Retrieves details about given subscription which is associated with the management group.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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)

{
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 ,
}
string ,
type:
{
Description: The type of the resource. For example, Microsoft.Management/managementGroups/subscriptions ,
Required: False ,
}
string ,
name:
{
Description: The stringified id of the subscription. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
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 details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
ManagementGroupSubscriptions_GetSubscriptionsUnderManagementGroup (new)
Description :  Retrieves details about all subscriptions which are associated with the management group.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/subscriptions
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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 list of subscriptions. ,
Required: False ,
}
[
{
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 ,
}
string ,
type:
{
Description: The type of the resource. For example, Microsoft.Management/managementGroups/subscriptions ,
Required: False ,
}
string ,
name:
{
Description: The stringified id of the subscription. For example, 00000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
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 URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
HierarchySettings_List (new)
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 ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/settings
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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 details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
HierarchySettings_Get (new)
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 ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/settings/default
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
HierarchySettings_CreateOrUpdate (new)
Description :  Creates or updates the hierarchy settings defined at the Management Group level.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{groupId}/settings/default
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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)

{
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
HierarchySettings_Update (new)
Description :  Updates the hierarchy settings defined at the Management Group level.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Management/managementGroups/{groupId}/settings/default
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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)

{
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
HierarchySettings_Delete (new)
Description :  Deletes the hierarchy settings defined at the Management Group level.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{groupId}/settings/default
{
groupId:
{
Description: Management Group ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all of the available Management REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/operations
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Microsoft.Management resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: The name of the provider. ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The operation that can be performed. ,
Required: False ,
}
string ,
description:
{
Description: Operation description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
CheckNameAvailability (new)
Description :  Checks if the specified management group name is valid and unique
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/checkNameAvailability
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: Management group name availability check parameters. ,
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: No description available. ,
AlreadyExists: No description available. ,
}
,
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 details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Entities_List (new)
Description :  List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/getEntities
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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. ,
Required: False ,
}
integer ,
$top:
{
Description: Number of elements to return when retrieving results. Passing this in will override $skipToken. ,
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 list of entities. ,
Required: False ,
}
[
{
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: No description available. ,
view: No description available. ,
edit: No description available. ,
delete: No description available. ,
}
,
Required: False ,
}
enum ,
inheritedPermissions:
{
Description: The users specific permissions to this item. ,
Enum:
{
noaccess: No description available. ,
view: No description available. ,
edit: No description available. ,
delete: No description available. ,
}
,
Required: False ,
}
enum ,
numberOfDescendants:
{
Required: False ,
}
integer ,
numberOfChildren:
{
Description: Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group. ,
Required: False ,
}
integer ,
numberOfChildGroups:
{
Description: Number of children is the number of Groups that are exactly one level underneath the current Group. ,
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 ,
]
,
}
,
}
,
]
,
count:
{
Description: Total count of records that match the filter ,
Required: False ,
}
integer ,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
StartTenantBackfill (new)
Description :  Starts backfilling subscriptions for the Tenant.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/startTenantBackfill
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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: No description available. ,
NotStartedButGroupsExist: No description available. ,
Started: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
TenantBackfillStatus (new)
Description :  Gets tenant backfill status
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/tenantBackfillStatus
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
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: No description available. ,
NotStartedButGroupsExist: No description available. ,
Started: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
ServiceGroups_Get (new)
Description :  Get the details of the serviceGroup
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
kind:
{
Description: The kind of the serviceGroup. ,
Required: False ,
}
string ,
tags:
{
Description: The serviceGroup tags. ,
Required: False ,
}
object ,
properties:
{
Description: ServiceGroup creation request body parameters. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the serviceGroup. For example, Running ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the serviceGroup. For example, ServiceGroupTest1 ,
Required: False ,
}
string ,
parent:
{
Description: The details of the parent serviceGroup. ,
Required: False ,
}
{
resourceId:
{
Description: The fully qualified ID of the parent serviceGroup. For example, '/providers/Microsoft.Management/serviceGroups/TestServiceGroup' ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
CreateOrUpdateServiceGroup (new)
Description :  Create or Update a serviceGroup
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/serviceGroups/{serviceGroupName}
{
serviceGroupName:
{
Description: ServiceGroup Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
createServiceGroupRequest:
{
Description: ServiceGroup creation parameters ,
Required: True ,
}
{
kind:
{
Description: The kind of the serviceGroup. ,
Required: False ,
}
string ,
tags:
{
Description: The serviceGroup tags. ,
Required: False ,
}
object ,
properties:
{
Description: ServiceGroup creation request body parameters. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the serviceGroup. For example, Running ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the serviceGroup. For example, ServiceGroupTest1 ,
Required: False ,
}
string ,
parent:
{
Description: The details of the parent serviceGroup. ,
Required: False ,
}
{
resourceId:
{
Description: The fully qualified ID of the parent serviceGroup. For example, '/providers/Microsoft.Management/serviceGroups/TestServiceGroup' ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: The kind of the serviceGroup. ,
Required: False ,
}
string ,
tags:
{
Description: The serviceGroup tags. ,
Required: False ,
}
object ,
properties:
{
Description: ServiceGroup creation request body parameters. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the serviceGroup. For example, Running ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the serviceGroup. For example, ServiceGroupTest1 ,
Required: False ,
}
string ,
parent:
{
Description: The details of the parent serviceGroup. ,
Required: False ,
}
{
resourceId:
{
Description: The fully qualified ID of the parent serviceGroup. For example, '/providers/Microsoft.Management/serviceGroups/TestServiceGroup' ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. To get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value. ,
}
string ,
}
,
$schema:
{
Description: The serviceGroup details. ,
}
{
kind:
{
Description: The kind of the serviceGroup. ,
Required: False ,
}
string ,
tags:
{
Description: The serviceGroup tags. ,
Required: False ,
}
object ,
properties:
{
Description: ServiceGroup creation request body parameters. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the serviceGroup. For example, Running ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the serviceGroup. For example, ServiceGroupTest1 ,
Required: False ,
}
string ,
parent:
{
Description: The details of the parent serviceGroup. ,
Required: False ,
}
{
resourceId:
{
Description: The fully qualified ID of the parent serviceGroup. For example, '/providers/Microsoft.Management/serviceGroups/TestServiceGroup' ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
UpdateServiceGroup (new)
Description :  Update a serviceGroup
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Management/serviceGroups/{serviceGroupName}
{
serviceGroupName:
{
Description: ServiceGroup Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateServiceGroupRequest:
{
Description: ServiceGroup update parameters ,
Required: True ,
}
{
kind:
{
Description: The kind of the serviceGroup. ,
Required: False ,
}
string ,
tags:
{
Description: The serviceGroup tags. ,
Required: False ,
}
object ,
properties:
{
Description: ServiceGroup creation request body parameters. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the serviceGroup. For example, Running ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the serviceGroup. For example, ServiceGroupTest1 ,
Required: False ,
}
string ,
parent:
{
Description: The details of the parent serviceGroup. ,
Required: False ,
}
{
resourceId:
{
Description: The fully qualified ID of the parent serviceGroup. For example, '/providers/Microsoft.Management/serviceGroups/TestServiceGroup' ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
kind:
{
Description: The kind of the serviceGroup. ,
Required: False ,
}
string ,
tags:
{
Description: The serviceGroup tags. ,
Required: False ,
}
object ,
properties:
{
Description: ServiceGroup creation request body parameters. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the serviceGroup. For example, Running ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the serviceGroup. For example, ServiceGroupTest1 ,
Required: False ,
}
string ,
parent:
{
Description: The details of the parent serviceGroup. ,
Required: False ,
}
{
resourceId:
{
Description: The fully qualified ID of the parent serviceGroup. For example, '/providers/Microsoft.Management/serviceGroups/TestServiceGroup' ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location: 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 ,
}
,
]
,
}
,
}
DeleteServiceGroup (new)
Description :  Delete a ServiceGroup
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/serviceGroups/{serviceGroupName}
{
serviceGroupName:
{
Description: ServiceGroup Name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL for determining when an operation has completed. Send a GET request to the URL in Location header. ,
}
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 ,
}
,
]
,
}
,
}
ServiceGroups_ListAncestors (new)
Description :  Get the details of the serviceGroup's ancestors
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Array of service groups based on the request criteria ,
Required: False ,
}
[
{
kind:
{
Description: The kind of the serviceGroup. ,
Required: False ,
}
string ,
tags:
{
Description: The serviceGroup tags. ,
Required: False ,
}
object ,
properties:
{
Description: ServiceGroup creation request body parameters. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the serviceGroup. For example, Running ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the serviceGroup. For example, ServiceGroupTest1 ,
Required: False ,
}
string ,
parent:
{
Description: The details of the parent serviceGroup. ,
Required: False ,
}
{
resourceId:
{
Description: The fully qualified ID of the parent serviceGroup. For example, '/providers/Microsoft.Management/serviceGroups/TestServiceGroup' ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to query the next page of results for this request ,
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 ,
}
,
]
,
}
,
}