management_groups
Creates, updates, deletes, gets or lists a management_groups resource.
Overview
| Name | management_groups |
| Type | Resource |
| Id | azure.management_groups.management_groups |
Fields
- vw_management_groups
- management_groups
| Name | Datatype | Description |
|---|---|---|
id | text | The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 |
name | text | The name of the management group. For example, 00000000-0000-0000-0000-000000000000 |
children | text | field from the properties object |
details | text | field from the properties object |
display_name | text | field from the properties object |
groupId | text | field from the properties object |
tenant_id | text | field from the properties object |
type | text | The type of the resource. For example, Microsoft.Management/managementGroups |
| Name | Datatype | 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 | object | The generic properties of a management group. |
type | string | The type of the resource. For example, Microsoft.Management/managementGroups |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get | SELECT | groupId | Get the details of the management group. |
list | SELECT | | List management groups for the authenticated user. |
create_or_update | INSERT | groupId | 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. | |||
delete | DELETE | groupId | Delete management group. |
| If a management group contains child resources, the request will fail. | |||
update | UPDATE | groupId | Update a management group. |
SELECT examples
List management groups for the authenticated user.
- vw_management_groups
- management_groups
SELECT
id,
name,
children,
details,
display_name,
groupId,
tenant_id,
type
FROM azure.management_groups.vw_management_groups
;
SELECT
id,
name,
properties,
type
FROM azure.management_groups.management_groups
;
INSERT example
Use the following StackQL query and manifest file to create a new management_groups resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.management_groups.management_groups (
groupId,
name,
properties
)
SELECT
'{{ groupId }}',
'{{ name }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: id
value: string
- name: type
value: string
- name: name
value: string
- name: properties
value:
- name: tenantId
value: string
- name: displayName
value: string
- name: details
value:
- name: version
value: number
- name: updatedTime
value: string
- name: updatedBy
value: string
- name: parent
value:
- name: id
value: string
- name: name
value: string
- name: displayName
value: string
- name: children
value:
- - name: type
value: []
- name: id
value: string
- name: name
value: string
- name: displayName
value: string
- name: children
value:
- - name: id
value: string
- name: name
value: string
- name: displayName
value: string
- name: children
value:
- - name: id
value: string
- name: name
value: string
- name: displayName
value: string
- name: children
value:
- - name: id
value: string
- name: name
value: string
- name: displayName
value: string
- name: children
value:
- - name: id
value: string
- name: name
value: string
- name: displayName
value: string
- name: children
value:
- - name: id
value: string
- name: name
value: string
- name: displayName
value: string
- name: children
value:
- - name: id
value: string
- name: name
value: string
- name: displayName
value: string
- name: children
value:
- - name: id
value: string
- name: name
value: string
- name: displayName
value: string
- name: children
value:
- - name: id
value: string
- name: name
value: string
- name: displayName
value: string
- name: children
value:
- []
UPDATE example
Updates a management_groups resource.
/*+ update */
UPDATE azure.management_groups.management_groups
SET
displayName = '{{ displayName }}',
parentGroupId = '{{ parentGroupId }}'
WHERE
groupId = '{{ groupId }}';
DELETE example
Deletes the specified management_groups resource.
/*+ delete */
DELETE FROM azure.management_groups.management_groups
WHERE groupId = '{{ groupId }}';