Azure / azure-cli

Azure Command-Line Interface
MIT License
4k stars 2.98k forks source link

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

Open odegroot opened 1 year ago

odegroot commented 1 year ago

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.

yonzhan commented 1 year ago

@jiasli for awareness