Management Group Subscriptions - Get Subscriptions Under Management Group

Reference

Service:: Management Groups

API Version:: 2020-05-01

Retrieves details about all subscriptions which are associated with the management group.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
groupId	path	True	string	Management Group ID.
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.

Responses

Name	Type	Description
200 OK	ListSubscriptionUnderManagementGroup	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

GetAllSubscriptionsFromManagementGroup

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "728bcbe4-8d56-4510-86c2-4921b8beefbc",
      "id": "/providers/Microsoft.Management/managementGroups/Group/subscriptions/728bcbe4-8d56-4510-86c2-4921b8beefbc",
      "type": "Microsoft.Management/managementGroups/subscriptions",
      "properties": {
        "displayName": "S5",
        "parent": {
          "id": "/providers/Microsoft.Management/managementGroups/Group"
        },
        "state": "Active",
        "tenant": "e751ac82-623b-4913-8d74-22637c832373"
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
DescendantParentGroupInfo	The ID of the parent management group.
ErrorDetails	The details of the error.
ErrorResponse	The error object.
ListSubscriptionUnderManagementGroup	The details of all subscriptions under management group.
SubscriptionUnderManagementGroup	The details of subscription under management group.

DescendantParentGroupInfo

The ID of the parent management group.

Name	Type	Description
id	string	The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000

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.

ListSubscriptionUnderManagementGroup

The details of all subscriptions under management group.

Name	Type	Description
nextLink	string	The URL to use for getting the next set of results.
value	SubscriptionUnderManagementGroup[]	The list of subscriptions.

SubscriptionUnderManagementGroup

The details of subscription under management group.

Name	Type	Description
id	string	The fully qualified ID for the subscription. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/subscriptions/0000000-0000-0000-0000-000000000001
name	string	The stringified id of the subscription. For example, 00000000-0000-0000-0000-000000000000
properties.displayName	string	The friendly name of the subscription.
properties.parent	DescendantParentGroupInfo	Parent The ID of the parent management group.
properties.state	string	The state of the subscription.
properties.tenant	string	The AAD Tenant ID associated with the subscription. For example, 00000000-0000-0000-0000-000000000000
type	string	The type of the resource. For example, Microsoft.Management/managementGroups/subscriptions