Microsoft.Management (preview:2018-01-01)

2025/09/26 • 10 new, 10 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 2018-01-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 ,
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. ,
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 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 ,
roles:
{
Description: The role definitions associated with 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 ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
type:
{
Description: The fully qualified resource type which includes provider namespace (e.g. /providers/Microsoft.Management/managementGroups) ,
Enum:
{
/providers/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 ,
roles:
{
Description: The roles definitions associated with the management group. ,
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 that the request shouldn't utilize any 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, /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 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 ,
roles:
{
Description: The roles definitions associated with the management group. ,
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. /providers/Microsoft.Management/managementGroups) ,
Enum:
{
/providers/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 ,
roles:
{
Description: The roles definitions associated with the management group. ,
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, /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 ,
roles:
{
Description: The role definitions associated with 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 ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
type:
{
Description: The fully qualified resource type which includes provider namespace (e.g. /providers/Microsoft.Management/managementGroups) ,
Enum:
{
/providers/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 ,
roles:
{
Description: The roles definitions associated with the management group. ,
Required: False ,
}
[
string ,
]
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
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:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status. ,
Enum:
{
Updating: 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 ,
}
,
}
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 that the request shouldn't utilize any caches. ,
Required: False ,
}
string ,
patchGroupRequest:
{
Description: Management group patch 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 ,
}
,
}

⚐ 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 ,
roles:
{
Description: The role definitions associated with 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 ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
type:
{
Description: The fully qualified resource type which includes provider namespace (e.g. /providers/Microsoft.Management/managementGroups) ,
Enum:
{
/providers/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 ,
roles:
{
Description: The roles definitions associated with the management group. ,
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 that the request shouldn't utilize any caches. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
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:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status. ,
Enum:
{
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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_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 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 ,
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 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 ,
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:
{
/providers/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 ,
groupName:
{
Description: A filter which allows the call to be filtered for a specific group. ,
Required: False ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /providers/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 ,
}
,
}
,
]
,
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_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 2018-01-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 ,
details:
{
Description: A human-readable representation of the error's details. ,
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 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. ,
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 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 ,
roles:
{
Description: The role definitions associated with 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 ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
type:
{
Description: The fully qualified resource type which includes provider namespace (e.g. /providers/Microsoft.Management/managementGroups) ,
Enum:
{
/providers/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 ,
roles:
{
Description: The roles definitions associated with the management group. ,
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 (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 2018-01-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /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 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 ,
roles:
{
Description: The roles definitions associated with the management group. ,
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. /providers/Microsoft.Management/managementGroups) ,
Enum:
{
/providers/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 ,
roles:
{
Description: The roles definitions associated with the management group. ,
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, /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 ,
roles:
{
Description: The role definitions associated with 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 ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
type:
{
Description: The fully qualified resource type which includes provider namespace (e.g. /providers/Microsoft.Management/managementGroups) ,
Enum:
{
/providers/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 ,
roles:
{
Description: The roles definitions associated with the management group. ,
Required: False ,
}
[
string ,
]
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
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:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status. ,
Enum:
{
Updating: 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 ,
}
,
}
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 2018-01-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any caches. ,
Required: False ,
}
string ,
patchGroupRequest:
{
Description: Management group patch 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 ,
}
,
}

⚐ 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 ,
roles:
{
Description: The role definitions associated with 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 ,
}
,
}
,
children:
{
Description: The list of children. ,
Required: False ,
}
[
{
type:
{
Description: The fully qualified resource type which includes provider namespace (e.g. /providers/Microsoft.Management/managementGroups) ,
Enum:
{
/providers/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 ,
roles:
{
Description: The roles definitions associated with the management group. ,
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 (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 2018-01-01-preview. ,
Required: True ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any caches. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
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:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning status. ,
Enum:
{
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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_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 2018-01-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 ,
details:
{
Description: A human-readable representation of the error's details. ,
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 2018-01-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 ,
details:
{
Description: A human-readable representation of the error's details. ,
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 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 (removed)
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:
{
/providers/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 (removed)
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 ,
groupName:
{
Description: A filter which allows the call to be filtered for a specific group. ,
Required: False ,
}
string ,
Cache-Control:
{
Description: Indicates that the request shouldn't utilize any 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, /providers/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 ,
}
,
}
,
]
,
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 ,
}
,
}