[Core] Allow authentication via environment variables #27938
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
VoxSecundus
requested review from
jiasli,
evelyn-ys,
calvinhzy,
jsntcy,
kairu-ms,
zhoxing-ms and
necusjz
as code owners
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
microsoft-github-policy-service
bot
requested review from
yonzhan and
yanzhudd
|
Core |
microsoft-github-policy-service
bot
added
the
customer-reported
|
Thank you for your contribution VoxSecundus! We will review the pull request and get back to you soon. |
microsoft-github-policy-service
bot
added
Compute
microsoft-github-policy-service
bot
added
Account
|
@microsoft-github-policy-service agree company="Alces Flight Ltd" |
jiasli
reviewed
Nov 29, 2023
Comment on lines
1357
to
1363
| def is_guid(guid): | ||
| import uuid | ||
| try: | ||
| uuid.UUID(guid) | ||
| return True | ||
| except (ValueError, TypeError): | ||
| return False |
There was a problem hiding this comment.
This function is already defined at
azure-cli/src/azure-cli-core/azure/cli/core/util.py
Lines 1233 to 1239 in a5198b5
jiasli
reviewed
Nov 29, 2023
|
|
||
| # If no login data, look for service principal credential in environment variables | ||
| if not self._entries and env_var_auth_configured(): | ||
| logger.warning("Using service principal credential configured in environment variables.") |
There was a problem hiding this comment.
Unconditionally showing warnings can breaks pipelines which enables failOnStderr (#18372).
There was a problem hiding this comment.
Sorry, I'm not sure what you mean. How should I make this warning shown "conditionally"?
There was a problem hiding this comment.
Sorry, I'm not sure what you mean. How should I make this warning shown "conditionally"?
Well. This warning shouldn't be printed at all, as it doesn't really qualify as a warning.
There was a problem hiding this comment.
Understood. It's been changed to a logger.debug call.
jiasli
reviewed
Nov 29, 2023
Comment on lines
313
to
316
| # If no login data, look for service principal credential in environment variables | ||
| if not self._entries and env_var_auth_configured(): | ||
| logger.warning("Using service principal credential configured in environment variables.") | ||
| self._entries = [load_env_var_credential()] |
There was a problem hiding this comment.
load_entry is designed solely for looking up service principal credentials stored on the hard disk. It may not be an ideal place for loading environment variables.
|
Thank you very much for the contribution. We understand #10241 is a highly demanded feature. Actually, I already have a draft work on supporting environment variable credential: https://github.com/jiasli/azure-cli/tree/env-cred, which utilizes the code from #22124. I will certainly take your PR into consideration while implementing this feature. |
VoxSecundus
force-pushed
the
feat/env-var-auth
branch
from
4e5a35a to
1bf27e3
Compare
|
Any update? |
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
azAll commands that require the user to be logged in.
Description
Addresses #10241
This PR updates the
_profileandauth/identityazure-cli-coreclasses to support authenticate for service principals via environment variables, without having to runaz loginfirst. When logged in withaz login, any credentials specified as environment variables are ignored.New variables:
AZURE_SUBSCRIPTION_ID--subscription.AZURE_TENANT_IDAZURE_CLIENT_IDAZURE_CLIENT_SECRETTesting Guide
In a Bash terminal:
azcommands as usual:$ az vm list [ { ... }, ... ] $ az account show { "id": null, "name": "Environment Variable Subscription", "tenantId": "<redacted>", "user": { "name": "<redacted>", "type": "servicePrincipal" } } $ az account get-access-token { "accessToken": "<redacted>", "expiresOn": "2023-11-28 18:51:46.000000", "expires_on": 1701197506, "subscription": "None", "tenant": "<redacted>", "tokenType": "Bearer" }History Notes
N/A
This 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.