-
Notifications
You must be signed in to change notification settings - Fork 486
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
Add doc for MSAL-based Azure CLI #2807
Merged
Merged
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
05fa8f0
Add doc for MSAL-based Azure CLI
jiasli 558ff5b
Fix CI
jiasli faa20f7
update
jiasli c804832
Apply suggestions from code review
jiasli a9127c9
Remove migrate-to-azure-identity.md
jiasli 3ca4e0e
Merge branch 'master' into msal
jiasli 9b34948
Merge branch 'master' into msal
jiasli 4ea79f7
Merge branch 'master' into msal
jiasli File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
This file was deleted.
Oops, something went wrong.
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: MSAL-based Azure CLI | Microsoft Docs | ||
description: Learn about the MSAL-based Azure CLI. | ||
author: dbradish-microsoft, jiasli | ||
ms.author: dbradish, jiasli | ||
manager: barbkess, yonzhan | ||
ms.date: 10/28/2021 | ||
ms.topic: conceptual | ||
ms.service: azure-cli | ||
ms.devlang: azurecli | ||
ms.custom: devx-track-azurecli, seo-azure-cli | ||
keywords: msal, msal-based azure cli | ||
--- | ||
|
||
# MSAL-based Azure CLI | ||
|
||
Starting from Azure CLI 2.30.0, Azure CLI uses [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-python) as the underlying authentication library, which internally uses AAD v2.0 authentication flow, provides more functionalities and increases security for token cache. | ||
jiasli marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
> [!WARNING] | ||
> BREAKING CHANGES are introduced in Azure CLI 2.30.0. Carefully read below document prior to installation. | ||
jiasli marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## `accessTokens.json` deprecation | ||
|
||
Previous versions of Azure CLI save ADAL tokens to `~/.azure/accessToken.json`. Now Azure CLI uses MSAL and no longer generates `accessTokens.json`. Any existing workflow depending on `accessTokens.json` will stop working. | ||
|
||
The MSAL token cache and service principal entries will be saved as encrypted files on Windows, and plaintext files on Linux and MacOS for now. | ||
jiasli marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Below are several alternatives you may consider: | ||
|
||
### Calling `az account get-access-token` | ||
|
||
You can manually call [`az account get-access-token`](account#az_account_get_access_token) in a terminal or use subprocess to call it from another programming language. By default, the returned access token is for Azure Resource Manager (ARM) and the default subscription/tenant shown in `az account show`. | ||
|
||
### Using `AzureCliCredential` | ||
|
||
`AzureCliCredential` is a credential type in all existing language SDKs. It internally uses subprocess to call `az account get-access-token` to get an access token for the current logged-in account. | ||
jiasli marked this conversation as resolved.
Show resolved
Hide resolved
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems I can't add multiple authors, otherwise the CI warns about it:
Invalid value for author: 'dbradish-microsoft, jiasli' is not a valid GitHub ID.
Invalid value for 'ms.author', 'dbradish, jiasli' is not a valid Microsoft alias.