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

The following fields are returned by SELECT queries:

list

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. (title: Properties)
type	string	The type of the resource. For example, Microsoft.Management/managementGroups/settings.

get

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. (title: Properties)
type	string	The type of the resource. For example, Microsoft.Management/managementGroups/settings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
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.
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.
create_or_update	insert	groupId		Creates or updates the hierarchy settings defined at the Management Group level.
update	update	groupId		Updates the hierarchy settings defined at the Management Group level.
delete	delete	groupId		Deletes the hierarchy settings defined at the Management Group level.

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.

SELECT examples

list

Gets all 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 }}' -- required
;

get

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 }}' -- required
;

INSERT examples

create_or_update

Creates or updates the hierarchy settings defined at the Management Group level.

INSERT INTO azure.management_groups.hierarchy_settings (
data__properties,
groupId
)
SELECT 
'{{ properties }}',
'{{ groupId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: hierarchy_settings
  props:
    - name: groupId
      value: string
      description: Required parameter for the hierarchy_settings resource.
    - name: properties
      value: object
      description: |
        The properties of the request to create or update Management Group settings

UPDATE examples

update

Updates the hierarchy settings defined at the Management Group level.

UPDATE azure.management_groups.hierarchy_settings
SET 
data__properties = '{{ properties }}'
WHERE 
groupId = '{{ groupId }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes the hierarchy settings defined at the Management Group level.

DELETE FROM azure.management_groups.hierarchy_settings
WHERE groupId = '{{ groupId }}' --required
;