{Auth} Show raw MSAL error in debug log#31746
Merged
Conversation
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
microsoft-github-policy-service
bot
added
the
ARM
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the aad_error_handler by logging the raw MSAL error payload in debug mode, aiding troubleshooting in constrained environments (e.g., Cloud Shell).
- Adds a dynamic JSON import and a debug log call to dump the MSAL error.
- Enables visibility into error details when running with
--debug.
Comments suppressed due to low confidence (2)
src/azure-cli-core/azure/cli/core/auth/util.py:30
- [nitpick] Adding or updating the docstring for
aad_error_handlerto mention that it logs the raw MSAL error when debug is enabled would clarify its behavior for future maintainers.
# az account get-access-token --scope https://my-invalid-scope
src/azure-cli-core/azure/cli/core/auth/util.py:33
- It would be helpful to add or update tests to verify that the raw MSAL error is correctly logged when
--debugis enabled, ensuring this new behavior is covered.
logger.debug('MSAL error: %s', json.dumps(error))
| # To trigger this function for testing, simply provide an invalid scope: | ||
| # az account get-access-token --scope https://my-invalid-scope | ||
|
|
||
| import json |
There was a problem hiding this comment.
[nitpick] Consider moving import json to the top of the module with the other imports to follow standard Python import practices and avoid repeated dynamic imports.
bebound
approved these changes
Jul 2, 2025
evelyn-ys
approved these changes
Jul 2, 2025
This file contains hidden or 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
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.
Description
This change was part of #28954, but was postponed.
Showing the MSAL error in the debug log can be very helpful for troubleshooting, especially in a managed identity or Cloud Shell environment where changing the source code is difficult (#31743 (comment)).
As confirmed with MSAL team, the MSAL error will only contain PII but not any credentials. Azure CLI doesn't send debug log to telemetry, so it is safe to display the MSAL error in the debug log.
Testing Guide