Azure / Azure/azure-cli

Confusing docs: management group name vs. displayName vs. id

Open
#25,334 1 comment 0 reactions 2 assignees Claimed by @jiasli View on GitHub
Account act-identity-squad ARM Auto-Assign Azure CLI Team customer-reported potential-pruning
Dominant language
Python
Stars
4.6k
Forks
3.5k
Avg merge
3d 2h
Merged PRs (30d)
60

Description

For Management Groups, Azure uses different property names in different locations.

| property name @Azure Portal | property name @ az cli | Example value |
| ------------- | ------------- | ------------- |
| Name | `displayName` | Production |
| ID | `name` | 628e99e2-3d07-4b2c-a8cb-725f277a0ed0 |
| - | `id` | /providers/Microsoft.Management/managementGroups/628e99e2-3d07-4b2c-a8cb-725f277a0ed0 |

Note that 'name' and 'id' mean different things in different places.

The docs for `az account management-group subscription add` say that the command has a required parameter `--name`, which is the "Name of the management group".

So which value is accepted? Is it the display name, is it the guid, or is either fine? (My tests show that it has to be the guid.)
Can you adjust the docs to clarify this?

---
#### Document Details

⚠ *Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.*

* ID: b03d9f16-ec30-f9b6-2ba2-3e3647c6ff99
* Version Independent ID: 52e77122-05dd-db99-f82a-6ccba7cbca57
* Content: [az account management-group subscription](https://learn.microsoft.com/en-us/cli/azure/account/management-group/subscription?view=azure-cli-latest#az-account-management-group-subscription-add)
* Content Source: [latest/docs-ref-autogen/account/management-group/subscription.yml](https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/account/management-group/subscription.yml)
* Service: **azure**
* GitHub Login: @rloutlaw
* Microsoft Alias: **routlaw**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.