hierarchy_settings

Creates, updates, deletes, gets or lists a hierarchy_settings resource.

Overview

Name	hierarchy_settings
Type	Resource
Id	azure.management_groups.hierarchy_settings

Fields

Name	Datatype	Description
id	string	The fully qualified ID for the settings object. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000/settings/default.
name	string	The name of the object. In this case, default.
properties	object	The generic properties of hierarchy settings.
type	string	The type of the resource. For example, Microsoft.Management/managementGroups/settings.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	groupId	Gets the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.
list	SELECT	groupId	Gets all the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.
create_or_update	INSERT	groupId	Creates or updates the hierarchy settings defined at the Management Group level.
delete	DELETE	groupId	Deletes the hierarchy settings defined at the Management Group level.
update	UPDATE	groupId	Updates the hierarchy settings defined at the Management Group level.

SELECT examples

Gets the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.

SELECT
id,
name,
properties,
type
FROM azure.management_groups.hierarchy_settings
WHERE groupId = '{{ groupId }}';

INSERT example

Use the following StackQL query and manifest file to create a new hierarchy_settings resource.

All Properties

/*+ create */
INSERT INTO azure.management_groups.hierarchy_settings (
groupId,
properties
)
SELECT 
'{{ groupId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: requireAuthorizationForGroupCreation
          value: boolean
        - name: defaultManagementGroup
          value: string

UPDATE example

Updates a hierarchy_settings resource.

/*+ update */
UPDATE azure.management_groups.hierarchy_settings
SET 
properties = '{{ properties }}'
WHERE 
groupId = '{{ groupId }}';

DELETE example

Deletes the specified hierarchy_settings resource.

/*+ delete */
DELETE FROM azure.management_groups.hierarchy_settings
WHERE groupId = '{{ groupId }}';