Management Groups - List

Reference

Service:: Management Groups

API Version:: 2020-05-01

List management groups for the authenticated user.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups?api-version=2020-05-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Management/managementGroups?api-version=2020-05-01&$skiptoken={$skiptoken}

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Version of the API to be used with the client request. The current version is 2018-01-01-preview.
$skiptoken	query		string	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.

Request Header

Name	Required	Type	Description
Cache-Control		string	Indicates that the request shouldn't utilize any caches.

Responses

Name	Type	Description
200 OK	ManagementGroupListResult	OK
Other Status Codes	ErrorResponse	Error

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ListManagementGroups

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups?api-version=2020-05-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000",
      "type": "Microsoft.Management/managementGroups",
      "name": "20000000-0001-0000-0000-000000000000",
      "properties": {
        "tenantId": "20000000-0000-0000-0000-000000000000",
        "displayName": "Group 1 Tenant 2"
      }
    },
    {
      "id": "/providers/Microsoft.Management/managementGroups/20000000-0004-0000-0000-000000000000",
      "type": "Microsoft.Management/managementGroups",
      "name": "20000000-0004-0000-0000-000000000000",
      "properties": {
        "tenantId": "20000000-0000-0000-0000-000000000000",
        "displayName": "Group 4 Tenant 2"
      }
    }
  ],
  "@nextLink": null
}

Definitions

Name	Description
ErrorDetails	The details of the error.
ErrorResponse	The error object.
ManagementGroupInfo	The management group resource.
ManagementGroupListResult	Describes the result of the request to list management groups.

ErrorDetails

The details of the error.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	string	A human-readable representation of the error's details.
message	string	A human-readable representation of the error.

ErrorResponse

The error object.

Name	Type	Description
error	ErrorDetails	Error The details of the error.

ManagementGroupInfo

The management group resource.

Name	Type	Description
id	string	The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000
name	string	The name of the management group. For example, 00000000-0000-0000-0000-000000000000
properties.displayName	string	The friendly name of the management group.
properties.tenantId	string	The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000
type	string	The type of the resource. For example, Microsoft.Management/managementGroups

ManagementGroupListResult

Describes the result of the request to list management groups.

Name	Type	Description
@nextLink	string	The URL to use for getting the next set of results.
value	ManagementGroupInfo[]	The list of management groups.