[Role] az ad sp create-for-rbac: Add alias --json-auth for --sdk-auth
#26572
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
️✔️AzureCLI-FullTest
|
|
| is_break | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| ad sp create-for-rbac | cmd ad sp create-for-rbac update parameter show_auth_for_sdk: updated property name from show_auth_for_sdk to show_auth_in_json |
||
| ad sp create-for-rbac | cmd ad sp create-for-rbac update parameter show_auth_for_sdk: updated property options from ['--sdk-auth'] to ['--json-auth', '--sdk-auth'] |
ghost
requested a review
from 
ghost
added
the
|
Role |
MoChilia
changed the title
az ad sp create-for-rbac: Add alias --json-auth for --sdk-authaz ad sp create-for-rbac: Add alias --json-auth for --sdk-auth
jiasli
reviewed
May 31, 2023
jiasli
reviewed
Jun 1, 2023
jiasli
reviewed
Jun 30, 2023
| c.argument('show_auth_in_json', options_list=['--sdk-auth', '--json-auth'], | ||
| deprecate_info=c.deprecate(target='--sdk-auth'), | ||
| help='Output service principal credential along with cloud endpoints in JSON format. ' | ||
| 'See https://learn.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli.', |
There was a problem hiding this comment.
We don't include /en-us in URLs in case this article supports multi-language in the future.
jiasli
reviewed
Jun 30, 2023
Comment on lines
184
to
185
| help='Output service principal credential along with cloud endpoints in JSON format. ' | ||
| 'See https://learn.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli.', |
There was a problem hiding this comment.
On a second thought, I think it may not be a good idea to include this URL. People who don't know what --sdk-auth does most likely don't need to use it as well. 🤣
If we do include the URL, please submit a PR to https://github.com/MicrosoftDocs/azure-docs-cli repo and link the PR ID here.
Or, maybe we should link to https://learn.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli at command level for better discovery.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
jiasli
approved these changes
Jul 3, 2023
avgale
pushed a commit
to avgale/azure-cli
that referenced
this pull request
Aug 24, 2023
…-auth` (Azure#26572) * Add alias `--json-auth` for `--sdk-auth` of `az ad sp create-for-rbac` * update help information * remove the url
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related command
az ad sp create-for-rbacDescription
This PR is going to add alias
--json-authfor the parameter--sdk-authof the commandaz ad sp create-for-rbac.As mentioned in #19872,
--sdk-authwas deprecated since Python SDK has deprecated the usage of the output JSON file, there are still other places where this JSON file is used, like GitHub Action. To avoid confusion in naming, we introduce the alias--json-authfor--sdk-auth.Some documents should be updated synchronously.
Close Azure/login#314
Testing Guide
az ad sp create-for-rbac --json-auth: with no deprecation messageaz ad sp create-for-rbac --sdk-auth: still shows deprecation messageHistory Notes
az ad sp create-for-rbac: Add alias--json-authfor--sdk-authThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.