descendants
Creates, updates, deletes, gets or lists a descendants resource.
Overview
| Name | descendants |
| Type | Resource |
| Id | azure.management_groups.descendants |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
id | string | The fully qualified ID for the descendant. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 or /subscriptions/0000000-0000-0000-0000-000000000000 |
name | string | The name of the descendant. For example, 00000000-0000-0000-0000-000000000000 |
properties | object | The generic properties of an descendant. (title: Properties) |
type | string | The type of the resource. For example, Microsoft.Management/managementGroups or /subscriptions |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | groupId | $skiptoken, $top | List all entities that descend from a management group. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
groupId | string | Management Group ID. |
$skiptoken | 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. |
$top | integer | Number of elements to return when retrieving results. Passing this in will override $skipToken. |
SELECT examples
- get
List all entities that descend from a management group.
SELECT
id,
name,
properties,
type
FROM azure.management_groups.descendants
WHERE groupId = '{{ groupId }}' -- required
AND $skiptoken = '{{ $skiptoken }}'
AND $top = '{{ $top }}'
;