Microsoft.Management (preview:2017-11-01)

2025/09/26 • 8 new, 8 deleted 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 2017-11-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /providers/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 ,
}
,
}
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 2017-11-01-preview. ,
Required: True ,
}
string ,
$expand:
{
Description: The $expand=children query string parameter allows clients to request inclusion of children in the response payload. ,
Required: False ,
}
string ,
$recurse:
{
Description: The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. ,
Required: False ,
}
boolean ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /providers/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 ,
}
{
parentId:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the parent management group. ,
Required: False ,
}
string ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
childType:
{
Description: The type of child resource. ,
Enum:
{
ManagementGroup: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
childId:
{
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 ,
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 ,
}
,
}
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 2017-11-01-preview. ,
Required: True ,
}
string ,
createManagementGroupRequest:
{
Description: Management group creation parameters. ,
Required: True ,
}
{
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
parentId:
{
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 ,
}
,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /providers/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 ,
}
{
parentId:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the parent management group. ,
Required: False ,
}
string ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
childType:
{
Description: The type of child resource. ,
Enum:
{
ManagementGroup: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
childId:
{
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 ,
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 ,
}
,
}
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 2017-11-01-preview. ,
Required: True ,
}
string ,
createManagementGroupRequest:
{
Description: Management group creation parameters. ,
Required: True ,
}
{
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
parentId:
{
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 ,
}
,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /providers/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 ,
}
{
parentId:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the parent management group. ,
Required: False ,
}
string ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
childType:
{
Description: The type of child resource. ,
Enum:
{
ManagementGroup: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
childId:
{
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 ,
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 ,
}
,
}
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 2017-11-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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 ,
}
,
}
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 2017-11-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any caches. ,
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 ,
}
,
}
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 2017-11-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any caches. ,
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 ,
}
,
}
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 2017-11-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 ,
}
,
}
ManagementGroups_List (removed)
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 2017-11-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /providers/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 ,
}
,
}
ManagementGroups_Get (removed)
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 2017-11-01-preview. ,
Required: True ,
}
string ,
$expand:
{
Description: The $expand=children query string parameter allows clients to request inclusion of children in the response payload. ,
Required: False ,
}
string ,
$recurse:
{
Description: The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. ,
Required: False ,
}
boolean ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /providers/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 ,
}
{
parentId:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the parent management group. ,
Required: False ,
}
string ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
childType:
{
Description: The type of child resource. ,
Enum:
{
ManagementGroup: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
childId:
{
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 ,
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 ,
}
,
}
ManagementGroups_CreateOrUpdate (removed)
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 2017-11-01-preview. ,
Required: True ,
}
string ,
createManagementGroupRequest:
{
Description: Management group creation parameters. ,
Required: True ,
}
{
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
parentId:
{
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 ,
}
,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /providers/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 ,
}
{
parentId:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the parent management group. ,
Required: False ,
}
string ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
childType:
{
Description: The type of child resource. ,
Enum:
{
ManagementGroup: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
childId:
{
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 ,
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 ,
}
,
}
ManagementGroups_Update (removed)
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 2017-11-01-preview. ,
Required: True ,
}
string ,
createManagementGroupRequest:
{
Description: Management group creation parameters. ,
Required: True ,
}
{
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
parentId:
{
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 ,
}
,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /providers/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 ,
}
{
parentId:
{
Description: The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the parent management group. ,
Required: False ,
}
string ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
childType:
{
Description: The type of child resource. ,
Enum:
{
ManagementGroup: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
childId:
{
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 ,
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 ,
}
,
}
ManagementGroups_Delete (removed)
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 2017-11-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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 ,
}
,
}
ManagementGroupSubscriptions_Create (removed)
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 2017-11-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any caches. ,
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 ,
}
,
}
ManagementGroupSubscriptions_Delete (removed)
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 2017-11-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any caches. ,
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 ,
}
,
}
Operations_List (removed)
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 2017-11-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 ,
}
,
}