{Core} Add comments to prevent calling AdalAuthentication._token_retriever #15854
Conversation
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
jiasli
requested review from
Juliehzl,
arrownj,
fengzhou-msft,
haroldrandom and
jsntcy
as code owners
Collaborator
|
Core |
evelyn-ys
approved these changes
Nov 11, 2020
This was referenced Apr 16, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
_token_retrieveris only available forAdalAuthenticationwhich is designed for user or Service Principal credential. It is not available for Managed Identity credentialMSIAuthenticationWrapper. Therefore, calling_token_retrieverto retrieve a raw token will fail for Managed Identity credential:This has already caused 2 buggy command module and extension: #15805, Azure/azure-cli-extensions#2461
This PR adds comments to prevent calling
AdalAuthentication._token_retrieverin the future by developers.For more detail including correct ways to get a raw token, see #15805 (comment).