Skip to content

Align design across client tools to avoid inconsistent for Microsoft Graph #22355

@jiasli

Description

@jiasli

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 uses the deprecated AD Graph property name -HomePage as the official parameter name:

image

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:

image

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:
    image
    However, in Microsoft Graph, replyUrls is split into web/redirectUris and publicClient/redirectUris, instead of replaced by web/redirectUris: image
    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 #12946 (comment)

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions