az account management-group hierarchy-settings

Provide operations for hierarchy settings defined at the management group level. Settings can only be set on the root Management Group of the hierarchy.

Commands

Name	Description	Type	Status
az account management-group hierarchy-settings create	Create hierarchy settings defined at the Management Group level.	Core	GA
az account management-group hierarchy-settings delete	Delete the hierarchy settings defined at the Management Group level.	Core	GA
az account management-group hierarchy-settings list	Get all the hierarchy settings defined at the Management Group level.	Core	GA
az account management-group hierarchy-settings update	Update the hierarchy settings defined at the Management Group level.	Core	GA

az account management-group hierarchy-settings create

Create hierarchy settings defined at the Management Group level.

az account management-group hierarchy-settings create --name
                                                      [--default-management-group]
                                                      [--require-authorization-for-group-creation]

Examples

Create hierarchy settings defined at the Management Group level.

az account management-group hierarchy-settings create --name GroupName

Set the default Management Group new Subscriptions get placed under.

az account management-group hierarchy-settings create --name GroupName -m /providers/Microsoft.Management/managementGroups/DefaultGroup

Require user to have Microsoft.Management/managementGroups/write access on the Root to create new Management Groups under the Root.

az account management-group hierarchy-settings create --name GroupName -r True

Update both hierarchy settings.

az account management-group hierarchy-settings create --name GroupName -m /providers/Microsoft.Management/managementGroups/DefaultGroup -r True

Required Parameters

--name -n

Name of the management group.

Optional Parameters

--default-management-group -m

Set the default Management Group under which new subscriptions get added in this tenant. Default setting is the Root Management Group.

--require-authorization-for-group-creation -r

Indicate whether RBAC access is required upon group creation under the root Management Group. True means user will require Microsoft.Management/managementGroups/write action on the root Management Group. Default setting is false.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az account management-group hierarchy-settings delete

Delete the hierarchy settings defined at the Management Group level.

az account management-group hierarchy-settings delete --name
                                                      [--yes]

Examples

Delete all hierarchy settings defined at the Management Group level.

az account management-group hierarchy-settings delete --name GroupName

Required Parameters

--name -n

Name of the management group.

Optional Parameters

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az account management-group hierarchy-settings list

Get all the hierarchy settings defined at the Management Group level.

az account management-group hierarchy-settings list --name

Examples

Get all hierarchy settings defined at the Management Group level.

az account management-group hierarchy-settings list --name GroupName

Required Parameters

--name -n

Name of the management group.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az account management-group hierarchy-settings update

Update the hierarchy settings defined at the Management Group level.

az account management-group hierarchy-settings update --name
                                                      [--add]
                                                      [--default-management-group]
                                                      [--force-string]
                                                      [--remove]
                                                      [--require-authorization-for-group-creation]
                                                      [--set]

Examples

Create hierarchy settings defined at the Management Group level.

az account management-group hierarchy-settings update --name GroupName

Set the default Management Group new Subscriptions get placed under.

az account management-group hierarchy-settings update --name GroupName -m /providers/Microsoft.Management/managementGroups/DefaultGroup

Require user to have Microsoft.Management/managementGroups/write access on the Root to create new Management Groups under the Root.

az account management-group hierarchy-settings update --name GroupName -r True

Update both hierarchy settings.

az account management-group hierarchy-settings update --name GroupName -m /providers/Microsoft.Management/managementGroups/DefaultGroup -r True

Required Parameters

--name -n

Name of the management group.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Default value: []

--default-management-group -m

Set the default Management Group under which new subscriptions get added in this tenant. Default setting is the Root Management Group.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []

--require-authorization-for-group-creation -r

Indicate whether RBAC access is required upon group creation under the root Management Group. True means user will require Microsoft.Management/managementGroups/write action on the root Management Group. Default setting is false.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.