Align design across client tools to avoid inconsistent for Microsoft Graph
- Dominant language
- Python
- Stars
- 4.6k
- Forks
- 3.5k
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 60
Description
## Discussion: whether to preserve deprecated AD Graph parameter names
There has been an internal discussion recently about whether we should **preserve deprecated AD Graph parameter names**.
### Azure PowerShell's solution: Keep AD Graph parameter names
For Azure PowerShell, after the Microsoft Graph migration, it uses
- **deprecated AD Graph parameter names as official names**
- **new Microsoft Graph parameter names as aliases**
For example, [`New-AzADApplication`](https://docs.microsoft.com/en-us/powershell/module/az.resources/new-azadapplication?view=azps-7.2.0) uses the deprecated AD Graph property name `-HomePage` as the official parameter name:

According to https://docs.microsoft.com/en-us/graph/migrate-azure-ad-graph-property-differences, `homepage` has been replaced by `web/homePageUrl` in Microsoft Graph:

The new corresponding parameter name should be `-WebHomePageUrl`, but `-WebHomePageUrl` is used as an alias, instead of the official name. Other parameters face similar problems:
- `-AvailableToOtherTenants` which conflicts with `-SignInAudience`
- `-ReplyUrls` vs `-WebRedirectUri`. `New-AzADApplication` makes `-ReplyUrls` and `-WebRedirectUri` the same:

However, in Microsoft Graph, `replyUrls` is split into `web/redirectUris` and `publicClient/redirectUris`, instead of replaced by `web/redirectUris`: 
meaning there is no one-one mapping between `replyUrls` and `web/redirectUris`.
### Problems
- New users of Microsoft Graph can't easily find the corresponding parameter names (`-WebHomePageUrl`). Instead, they will have to learn the deprecated AD Graph parameter names (`-HomePage`). This increases learning effort for new users.
- The cmdlet parameter doesn't match the output - `-HomePage` maps to `web/homePageUrl`, introducing inconsistency.
### Azure CLI's solution: be consistent with new Microsoft Graph API
Currently, as detailed in https://docs.microsoft.com/cli/azure/microsoft-graph-migration, we decide to replace deprecated AD Graph parameter names with new Microsoft Graph ones, such as
> `--homepage` argument is replaced by `--web-home-page-url`
If you have any feedback, please feel free to left a comment in this issue.
_Originally posted by @jiasli in https://github.com/Azure/azure-cli/issues/12946#issuecomment-1058796773_
Contributor guide
Assessment
This issue has not been assessed yet.