{Profile} Add CREDENTIAL_WARNING_MESSAGE for more commands #16222
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,89 +8,96 @@ | |
| from knack.help_files import helps # pylint: disable=unused-import | ||
|
|
||
| helps['login'] = """ | ||
| type: command | ||
| short-summary: Log in to Azure. | ||
| examples: | ||
| - name: Log in interactively. | ||
| text: > | ||
| az login | ||
| - name: Log in with user name and password. This doesn't work with Microsoft accounts or accounts that have two-factor authentication enabled. Use -p=secret if the first character of the password is '-'. | ||
| text: > | ||
| az login -u [email protected] -p VerySecret | ||
| - name: Log in with a service principal using client secret. Use -p=secret if the first character of the password is '-'. | ||
| text: > | ||
| az login --service-principal -u http://azure-cli-2016-08-05-14-31-15 -p VerySecret --tenant contoso.onmicrosoft.com | ||
| - name: Log in with a service principal using client certificate. | ||
| text: > | ||
| az login --service-principal -u http://azure-cli-2016-08-05-14-31-15 -p ~/mycertfile.pem --tenant contoso.onmicrosoft.com | ||
| - name: Log in using a VM's system assigned identity | ||
| text: > | ||
| az login --identity | ||
| - name: Log in using a VM's user assigned identity. Client or object ids of the service identity also work | ||
| text: > | ||
| az login --identity -u /subscriptions/<subscriptionId>/resourcegroups/myRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myID | ||
| """ | ||
|
|
||
| helps['account'] = """ | ||
| type: group | ||
| short-summary: Manage Azure subscription information. | ||
| """ | ||
|
|
||
| helps['account clear'] = """ | ||
| type: command | ||
| short-summary: Clear all subscriptions from the CLI's local cache. | ||
| long-summary: To clear the current subscription, use 'az logout'. | ||
| """ | ||
|
|
||
| helps['account list'] = """ | ||
| type: command | ||
| short-summary: Get a list of subscriptions for the logged in account. | ||
| """ | ||
|
|
||
| helps['account list-locations'] = """ | ||
| type: command | ||
| short-summary: List supported regions for the current subscription. | ||
| """ | ||
|
|
||
| helps['account show'] = """ | ||
| type: command | ||
| short-summary: Get the details of a subscription. | ||
| long-summary: If no subscription is specified, shows the current subscription. | ||
| """ | ||
|
|
||
| helps['account set'] = """ | ||
| type: command | ||
| short-summary: Set a subscription to be the current active subscription. | ||
| """ | ||
|
|
||
| helps['account show'] = """ | ||
| type: command | ||
| short-summary: Get the details of a subscription. | ||
| long-summary: >- | ||
| If the subscription isn't specified, shows the details of the default subscription. | ||
|
|
||
|
|
||
| When --sdk-auth is used, | ||
| the output includes credentials that you must protect. Be sure that you do not include these credentials | ||
| in your code or check the credentials into your source control. As an alternative, consider using | ||
| [managed identities](https://aka.ms/azadsp-managed-identities) if available to avoid the need to use credentials. | ||
|
||
| """ | ||
|
|
||
| helps['account get-access-token'] = """ | ||
| type: command | ||
| short-summary: Get a token for utilities to access Azure. | ||
| long-summary: > | ||
| The token will be valid for at least 5 minutes with the maximum at 60 minutes. | ||
| If the subscription argument isn't specified, the current account is used. | ||
| examples: | ||
| - name: Get an access token for the current account | ||
| text: > | ||
| az account get-access-token | ||
| - name: Get an access token for a specific subscription | ||
| text: > | ||
| az account get-access-token --subscription 00000000-0000-0000-0000-000000000000 | ||
| - name: Get an access token for a specific tenant | ||
| text: > | ||
| az account get-access-token --tenant 00000000-0000-0000-0000-000000000000 | ||
| - name: Get an access token to use with MS Graph API | ||
| text: > | ||
| az account get-access-token --resource-type ms-graph | ||
| """ | ||
|
|
||
| helps['self-test'] = """ | ||
| type: command | ||
| short-summary: Runs a self-test of the CLI. | ||
| """ | ||
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
⚠
--sdk-authshould be deprecated foraz account showbecause it is regurgitating the credential which is not a secure practice.