Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc]: Connect-AzAccount Parameter Sets Cannot Describe the Functions and Usages Properly #25103

Open
msJinLei opened this issue Jun 6, 2024 · 3 comments
Labels
Accounts Issues in Az.Accounts except authentication related feature-request This issue requires a new behavior in the product in order be resolved. P2 Tracking We will track status and follow internally

Comments

@msJinLei
Copy link
Contributor

msJinLei commented Jun 6, 2024

Type of issue

Other (describe below)

Feedback

Currently the parameter sets of Connect-AzAccount don't describe the usages and functions

For example

  • In the default parameter set "UserWithSubscriptionId (Default)", subscription is optional and so why it is named as "WithSubscriptionId"? Further, UserWithCredential is also a user flow and with subscription .
  • For the parameter sets ServicePrincipalWithSubscriptionId, ServicePrincipalCertificateWithSubscriptionId, ServicePrincipalCertificateFileWithSubscriptionId and AccessTokenWithSubscriptionId, what's the meaning for "WithSubscriptionId" as the "subscripiton" is optional for all the parameter sets?

Page URL

No response

Content source URL

https://github.com/Azure/azure-powershell/blob/main/src/Accounts/Accounts/help/Connect-AzAccount.md

Author

No response

Document Id

No response

@msJinLei msJinLei added the needs-triage This is a new issue that needs to be triaged to the appropriate team. label Jun 6, 2024
@msJinLei msJinLei changed the title [Doc]: Connect-AzAccount Parameter Sets Cannot Describe the Authentication Flow Correctly [Doc]: Connect-AzAccount Parameter Sets Cannot Describe the Functions and Usages Properly Jun 6, 2024
@isra-fel
Copy link
Member

isra-fel commented Jun 6, 2024

Name of parameter sets is not exposed to cx. This is not urgent.

@isra-fel isra-fel added feature-request This issue requires a new behavior in the product in order be resolved. P2 Accounts Issues in Az.Accounts except authentication related and removed needs-triage This is a new issue that needs to be triaged to the appropriate team. labels Jun 6, 2024
@msJinLei
Copy link
Contributor Author

msJinLei commented Jun 6, 2024

Name of parameter sets is not exposed to cx. This is not urgent.

@isra-fel Not just name. I propose to separate device code flow from "UserWithSubscriptionId" and merge "ServicePrincipalCertificateFileWithSubscriptionId" and "ServicePrincipalCertificateWithSubscriptionId"

@isra-fel
Copy link
Member

Yes it probably makes sense to seperate the parameter sets according to auth flows, as it's more intuitive for users and developers - but we need to be careful not to cause breaking changes.

@isra-fel isra-fel added the Tracking We will track status and follow internally label Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accounts Issues in Az.Accounts except authentication related feature-request This issue requires a new behavior in the product in order be resolved. P2 Tracking We will track status and follow internally
Projects
None yet
Development

No branches or pull requests

2 participants