management-group.yml

### YamlMime:AzureCLIGroup
uid: az_account_management-group
name: az account management-group
summary: |-
  Manage Azure Management Groups.
status: GA
sourceType: Core
directCommands:
- uid: az_account_management-group_check-name-availability
  name: az account management-group check-name-availability
  summary: |-
    Check if a Management Group Name is Valid.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: az account management-group check-name-availability --name
  examples:
  - summary: |-
      Check if a Management Group Name is Valid.
    syntax: az account management-group check-name-availability --name GroupName
  requiredParameters:
  - isRequired: true
    name: --name -n
    summary: |-
      Name of the management group.
- uid: az_account_management-group_create
  name: az account management-group create
  summary: |-
    Create a new management group.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: >-
    az account management-group create --name
                                       [--display-name]
                                       [--no-register]
                                       [--parent]
  examples:
  - summary: |-
      Create a new management group.
    syntax: az account management-group create --name GroupName
  - summary: |-
      Create a new management group with a specific display name.
    syntax: az account management-group create --name GroupName --display-name DisplayName
  - summary: |-
      Create a new management group with a specific parent.
    syntax: az account management-group create --name GroupName --parent ParentId/ParentName
  - summary: |-
      Create a new management group with a specific display name and parent.
    syntax: az account management-group create --name GroupName --display-name DisplayName --parent ParentId/ParentName
  requiredParameters:
  - isRequired: true
    name: --name -n
    summary: |-
      Name of the management group.
  optionalParameters:
  - name: --display-name -d
    summary: |-
      Sets the display name of the management group. If null, the group name is set as the display name.
  - name: --no-register
    defaultValue: "False"
    summary: |-
      Skip registration for resource provider Microsoft.Management.
  - name: --parent -p
    summary: |-
      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.
- uid: az_account_management-group_delete
  name: az account management-group delete
  summary: |-
    Delete an existing management group.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: >-
    az account management-group delete --name
                                       [--no-register]
  examples:
  - summary: |-
      Delete an existing management group
    syntax: az account management-group delete --name GroupName
  requiredParameters:
  - isRequired: true
    name: --name -n
    summary: |-
      Name of the management group.
  optionalParameters:
  - name: --no-register
    defaultValue: "False"
    summary: |-
      Skip registration for resource provider Microsoft.Management.
- uid: az_account_management-group_list
  name: az account management-group list
  summary: |-
    List all management groups in the current tenant.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: az account management-group list [--no-register]
  examples:
  - summary: |-
      List all management groups
    syntax: az account management-group list
  optionalParameters:
  - name: --no-register
    defaultValue: "False"
    summary: |-
      Skip registration for resource provider Microsoft.Management.
- uid: az_account_management-group_show
  name: az account management-group show
  summary: |-
    Get the details of the management group.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: >-
    az account management-group show --name
                                     [--expand]
                                     [--no-register]
                                     [--recurse]
  examples:
  - summary: |-
      Get a management group.
    syntax: az account management-group show --name GroupName
  - summary: |-
      Get a management group with children in the first level of hierarchy.
    syntax: az account management-group show --name GroupName -e
  - summary: |-
      Get a management group with children in all levels of hierarchy.
    syntax: az account management-group show --name GroupName -e -r
  requiredParameters:
  - isRequired: true
    name: --name -n
    summary: |-
      Name of the management group (the last segment of the resource ID). Do not use display name.
  optionalParameters:
  - name: --expand -e
    defaultValue: "False"
    summary: |-
      If given, lists the children in the first level of hierarchy.
  - name: --no-register
    defaultValue: "False"
    summary: |-
      Skip registration for resource provider Microsoft.Management.
  - name: --recurse -r
    defaultValue: "False"
    summary: |-
      If given, lists the children in all levels of hierarchy.
- uid: az_account_management-group_update
  name: az account management-group update
  summary: |-
    Update an existing management group.
  status: GA
  sourceType: Core
  editLink: https://github.com/Azure/azure-cli/blob/dev/src/azure-cli/azure/cli/command_modules/profile/_help.py
  syntax: >-
    az account management-group update --name
                                       [--add]
                                       [--display-name]
                                       [--force-string]
                                       [--parent]
                                       [--remove]
                                       [--set]
  examples:
  - summary: |-
      Update an existing management group with a specific display name.
    syntax: az account management-group update --name GroupName --display-name DisplayName
  - summary: |-
      Update an existing management group with a specific parent.
    syntax: az account management-group update --name GroupName --parent ParentId/ParentName
  - summary: |-
      Update an existing management group with a specific display name and parent.
    syntax: az account management-group update --name GroupName --display-name DisplayName --parent ParentId/ParentName
  requiredParameters:
  - isRequired: true
    name: --name -n
    summary: |-
      Name of the management group.
  optionalParameters:
  - name: --add
    defaultValue: "[]"
    summary: |-
      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>`.
  - name: --display-name -d
    summary: |-
      Updates the display name of the management group. If null, no change is made.
  - name: --force-string
    defaultValue: "False"
    summary: |-
      When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
  - name: --parent -p
    summary: |-
      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.
  - name: --remove
    defaultValue: "[]"
    summary: |-
      Remove a property or an element from a list.  Example: `--remove property.list <indexToRemove>` OR `--remove propertyToRemove`.
  - name: --set
    defaultValue: "[]"
    summary: |-
      Update an object by specifying a property path and value to set.  Example: `--set property1.property2=<value>`.
commands:
- az_account_management-group_check-name-availability
- az_account_management-group_create
- az_account_management-group_delete
- az_account_management-group_entities
- az_account_management-group_entities_list
- az_account_management-group_hierarchy-settings
- az_account_management-group_hierarchy-settings_create
- az_account_management-group_hierarchy-settings_delete
- az_account_management-group_hierarchy-settings_list
- az_account_management-group_hierarchy-settings_update
- az_account_management-group_list
- az_account_management-group_show
- az_account_management-group_subscription
- az_account_management-group_subscription_add
- az_account_management-group_subscription_remove
- az_account_management-group_subscription_show
- az_account_management-group_subscription_show-sub-under-mg
- az_account_management-group_tenant-backfill
- az_account_management-group_tenant-backfill_get
- az_account_management-group_tenant-backfill_start
- az_account_management-group_update
globalParameters:
- name: --debug
  summary: |-
    Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: |-
    Show this help message and exit.
- name: --only-show-errors
  summary: |-
    Only show errors, suppressing warnings.
- name: --output -o
  defaultValue: "json"
  parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
  summary: |-
    Output format.
- name: --query
  summary: |-
    JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
  summary: |-
    Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
  summary: |-
    Increase logging verbosity. Use --debug for full debug logs.
metadata:
  ms.date: 01/22/2025
  description: Manage Azure Management Groups.