az account management-group

Manage Azure Management Groups.

Commands

Name Description Type Status
az account management-group check-name-availability

Check if a Management Group Name is Valid.

Core GA
az account management-group create

Create a new management group.

Core GA
az account management-group delete

Delete an existing management group.

Core GA
az account management-group entities

Entity operations (Management Group and Subscriptions) for Management Groups.

Core GA
az account management-group entities list

List all entities for the authenticated user.

Core GA
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.

Core GA
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 list

List all management groups in the current tenant.

Core GA
az account management-group show

Get the details of the management group.

Core GA
az account management-group subscription

Subscription operations for Management Groups.

Core GA
az account management-group subscription add

Add a subscription to a management group.

Core GA
az account management-group subscription remove

Remove an existing subscription from a management group.

Core GA
az account management-group subscription show

Show the details of a subscription under a known management group.

Core GA
az account management-group subscription show-sub-under-mg

Get the subscription under a management group.

Core GA
az account management-group tenant-backfill

Backfill Tenant Subscription Operations for Management Groups.

Core GA
az account management-group tenant-backfill get

Get the backfill status for a tenant.

Core GA
az account management-group tenant-backfill start

Start backfilling subscriptions for a tenant.

Core GA
az account management-group update

Update an existing management group.

Core GA

az account management-group check-name-availability

Check if a Management Group Name is Valid.

az account management-group check-name-availability --name

Examples

Check if a Management Group Name is Valid.

az account management-group check-name-availability --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 create

Create a new management group.

az account management-group create --name
                                   [--display-name]
                                   [--no-register]
                                   [--parent]

Examples

Create a new management group.

az account management-group create --name GroupName

Create a new management group with a specific display name.

az account management-group create --name GroupName --display-name DisplayName

Create a new management group with a specific parent.

az account management-group create --name GroupName --parent ParentId/ParentName

Create a new management group with a specific display name and parent.

az account management-group create --name GroupName --display-name DisplayName --parent ParentId/ParentName

Required Parameters

--name -n

Name of the management group.

Optional Parameters

--display-name -d

Sets the display name of the management group. If null, the group name is set as the display name.

--no-register

Skip registration for resource provider Microsoft.Management.

Default value: False
--parent -p

Sets the parent of the management group. Can be the fully qualified id or the name of the management group. If null, the root tenant group is set as the parent.

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 delete

Delete an existing management group.

az account management-group delete --name
                                   [--no-register]

Examples

Delete an existing management group

az account management-group delete --name GroupName

Required Parameters

--name -n

Name of the management group.

Optional Parameters

--no-register

Skip registration for resource provider Microsoft.Management.

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 list

List all management groups in the current tenant.

az account management-group list [--no-register]

Examples

List all management groups

az account management-group list

Optional Parameters

--no-register

Skip registration for resource provider Microsoft.Management.

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 show

Get the details of the management group.

az account management-group show --name
                                 [--expand]
                                 [--no-register]
                                 [--recurse]

Examples

Get a management group.

az account management-group show --name GroupName

Get a management group with children in the first level of hierarchy.

az account management-group show --name GroupName -e

Get a management group with children in all levels of hierarchy.

az account management-group show --name GroupName -e -r

Required Parameters

--name -n

Name of the management group (the last segment of the resource ID). Do not use display name.

Optional Parameters

--expand -e

If given, lists the children in the first level of hierarchy.

Default value: False
--no-register

Skip registration for resource provider Microsoft.Management.

Default value: False
--recurse -r

If given, lists the children in all levels of hierarchy.

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 update

Update an existing management group.

az account management-group update --name
                                   [--add]
                                   [--display-name]
                                   [--force-string]
                                   [--parent]
                                   [--remove]
                                   [--set]

Examples

Update an existing management group with a specific display name.

az account management-group update --name GroupName --display-name DisplayName

Update an existing management group with a specific parent.

az account management-group update --name GroupName --parent ParentId/ParentName

Update an existing management group with a specific display name and parent.

az account management-group update --name GroupName --display-name DisplayName --parent ParentId/ParentName

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: []
--display-name -d

Updates the display name of the management group. If null, no change is made.

--force-string

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

Default value: False
--parent -p

Update the parent of the management group. Can be the fully qualified id or the name of the management group. If null, no change is made.

--remove

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

Default value: []
--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.