Microsoft.Management (preview:2017-08-31)

2025/09/26 • 3 new, 3 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-08-31-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 management groups. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the management group. E.g. /providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. /providers/Microsoft.Management/managementGroups ,
Required: False ,
}
string ,
name:
{
Description: The name of the management group. E.g. 20000000-0000-0000-0000-000000000000 ,
Format: uuid ,
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. E.g. 10000000-0000-0000-0000-000000000000 ,
Format: uuid ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next page 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 ,
target:
{
Description: (Optional) The target 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. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-08-31-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 ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the management group. E.g. /providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. /providers/Microsoft.Management/managementGroups ,
Required: False ,
}
string ,
name:
{
Description: The name of the management group. E.g. 20000000-0000-0000-0000-000000000000 ,
Format: uuid ,
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. E.g. 10000000-0000-0000-0000-000000000000 ,
Format: uuid ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
details:
{
Description: The details properties 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 ID of the parent management group. E.g. /providers/Microsoft.Management/managementGroups/30000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
}
,
managementGroupType:
{
Description: (Optional) The type of the management group. ,
Enum:
{
Enrollment: No description available. ,
Department: No description available. ,
Account: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
childType:
{
Description: (Optional) The type of the management group. ,
Enum:
{
Enrollment: No description available. ,
Department: No description available. ,
Account: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
childId:
{
Description: The ID of the child resource (management group or subscription). E.g. /providers/Microsoft.Management/managementGroups/40000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the child resource. ,
Required: False ,
}
string ,
tenantId:
{
Description: (Optional) The AAD Tenant ID associated with the child resource. ,
Format: uuid ,
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 ,
target:
{
Description: (Optional) The target 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-08-31-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of management 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: Service provider: Microsoft.Management. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
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 ,
target:
{
Description: (Optional) The target 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-08-31-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 management groups. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the management group. E.g. /providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. /providers/Microsoft.Management/managementGroups ,
Required: False ,
}
string ,
name:
{
Description: The name of the management group. E.g. 20000000-0000-0000-0000-000000000000 ,
Format: uuid ,
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. E.g. 10000000-0000-0000-0000-000000000000 ,
Format: uuid ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next page 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 ,
target:
{
Description: (Optional) The target 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. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-08-31-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 ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the management group. E.g. /providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. /providers/Microsoft.Management/managementGroups ,
Required: False ,
}
string ,
name:
{
Description: The name of the management group. E.g. 20000000-0000-0000-0000-000000000000 ,
Format: uuid ,
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. E.g. 10000000-0000-0000-0000-000000000000 ,
Format: uuid ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
details:
{
Description: The details properties 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 ID of the parent management group. E.g. /providers/Microsoft.Management/managementGroups/30000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the management group. ,
Required: False ,
}
string ,
}
,
managementGroupType:
{
Description: (Optional) The type of the management group. ,
Enum:
{
Enrollment: No description available. ,
Department: No description available. ,
Account: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
childType:
{
Description: (Optional) The type of the management group. ,
Enum:
{
Enrollment: No description available. ,
Department: No description available. ,
Account: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
childId:
{
Description: The ID of the child resource (management group or subscription). E.g. /providers/Microsoft.Management/managementGroups/40000000-0000-0000-0000-000000000000 ,
Required: False ,
}
string ,
displayName:
{
Description: The friendly name of the child resource. ,
Required: False ,
}
string ,
tenantId:
{
Description: (Optional) The AAD Tenant ID associated with the child resource. ,
Format: uuid ,
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 ,
target:
{
Description: (Optional) The target 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-08-31-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of management 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: Service provider: Microsoft.Management. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
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 ,
target:
{
Description: (Optional) The target of the error. ,
Required: False ,
}
string ,
}
,
}