[Reference] freshness project: Profile (az account, az login)
#24633
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 | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -10,42 +10,50 @@ | |||||||
| 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. | ||||||||
| text: az login --user [email protected] --password VerySecret | ||||||||
| - name: Log in with a password containing a `-` as the first character. | ||||||||
| text: az login --user [email protected] --password=-myPasswordThatStartsWithAdash | ||||||||
| - name: Log in with a service principal using a client secret. | ||||||||
| text: az login --service-principal --user http://azure-cli-2016-08-05-14-31-15 --password VerySecret --tenant contoso.onmicrosoft.com | ||||||||
| - name: Log in with a service principal using a client certificate. | ||||||||
| text: aaz login --service-principal --user http://azure-cli-2016-08-05-14-31-15 --password ~/MyCertfile.pem --tenant contoso.onmicrosoft.com | ||||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||||
| - name: Log in using a VM's system assigned identity. | ||||||||
|
Member
There was a problem hiding this comment.
Suggested change
Not only VM has managed identity. Also, if no system-assigned identity is configured, but a user assigned identity is, this command uses the user-assigned identity as the default one. If both system-assigned identity and user-assigned identity are configured, system-assigned identity is chosen as the default. |
||||||||
| text: az login --identity | ||||||||
| - name: Log in using a VM's user assigned identity. Client or object ids of the service identity also work. | ||||||||
|
Member
There was a problem hiding this comment.
Suggested change
There should be a hyphen in |
||||||||
| text: az login --identity --user /subscriptions/MySubscriptionID/resourcegroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myID | ||||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||||
| """ | ||||||||
|
|
||||||||
| helps['account'] = """ | ||||||||
| type: group | ||||||||
| short-summary: Manage Azure subscription information. | ||||||||
| long-summary: > | ||||||||
| Use `az login` to log into Azure before managing subscriptions. | ||||||||
| For an in-depth overview of working with subscriptions using the Azure CLI, see | ||||||||
| [How to manage Azure subscriptions with the Azure CLI](https://learn.microsoft.com/cli/azure/manage-azure-subscriptions-azure-cli). | ||||||||
| """ | ||||||||
|
|
||||||||
| 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. | ||||||||
| examples: | ||||||||
| - name: List all subscriptions. | ||||||||
| text: az account list --all | ||||||||
| - name: List all enabled subscriptions. | ||||||||
| text: az account list | ||||||||
| - name: Get the current default subscription. | ||||||||
| text: az account list --query "[?isDefault]" | ||||||||
|
Member
There was a problem hiding this comment. This example has little real-world usage, as it can be replaced by |
||||||||
| - name: Refresh the list of subscriptions. | ||||||||
| text: az account list --refresh | ||||||||
| """ | ||||||||
|
|
||||||||
| helps['account list-locations'] = """ | ||||||||
|
|
@@ -56,39 +64,67 @@ | |||||||
| helps['account show'] = """ | ||||||||
| type: command | ||||||||
| short-summary: Get the details of a subscription. | ||||||||
| long-summary: If no subscription is specified, information for the current subscription is returned. | ||||||||
| examples: | ||||||||
| - name: Get the current default subscription returning results in your default format. | ||||||||
|
Member
There was a problem hiding this comment.
This applies to all commands, not only |
||||||||
| text: az account show | ||||||||
| - name: Get information about a named subscription returning results as a table. Use `--output yaml` for plain text. | ||||||||
| text: az account show --name "My subscription name" --output table | ||||||||
| - name: Get information about a subscription using the subscription ID. | ||||||||
| text: az account show --name MySubscriptionID | ||||||||
| - name: > | ||||||||
| Get specific information about a subscription using `--query`. | ||||||||
| To see available query options, first run `az account show --output json`. | ||||||||
| For in-depth `--query` examples see [How to query Azure CLI command output using a JMESPath query](https://learn.microsoft.com/cli/azure/query-azure-cli). | ||||||||
|
Comment on lines
+76
to
+78
Member
There was a problem hiding this comment. As discussed in #24332 (comment), I am hesitating on whether we want to add examples for generic argument |
||||||||
| text: > | ||||||||
| az account show --query user.name | ||||||||
|
Comment on lines
+79
to
+80
Member
There was a problem hiding this comment.
Suggested change
|
||||||||
| - name: Return results in plain text. | ||||||||
| text: az account show --query MyTenantID --output tsv | ||||||||
| - name: Store the default subscription ID in a variable. | ||||||||
| text: > | ||||||||
| # Bash script | ||||||||
| subscriptionId="$(az account show --query id --output tsv)" | ||||||||
| echo "The current subscription ID is $subscriptionId" | ||||||||
|
Comment on lines
+85
to
+87
Member
There was a problem hiding this comment. Extra line break is needed as L84 uses We can test the rendered help message by running |
||||||||
| """ | ||||||||
|
|
||||||||
| helps['account set'] = """ | ||||||||
| type: command | ||||||||
| short-summary: Change the active subscription. | ||||||||
| examples: | ||||||||
| - name: Change the active subscription using a subscription name | ||||||||
| text: az account set --subscription "My subscription name" | ||||||||
| - name: Change the active subscription using a subscription ID | ||||||||
| text: az account set --subscription MySubscriptionID | ||||||||
| - name: Change the active subscription using a variable. | ||||||||
| text: > | ||||||||
| # Bash script | ||||||||
| subscriptionId="$(az account list --query "[?contains(name, 'OneOfMySubscriptionNames')].id" --output tsv)" | ||||||||
|
Member
There was a problem hiding this comment. |
||||||||
| az account set --subscription $subscriptionId | ||||||||
| echo "The current subscription has been set to $subscriptionId" | ||||||||
|
Comment on lines
+101
to
+103
Member
There was a problem hiding this comment. Similar to #24332 (comment) These lines can simply be done with |
||||||||
| """ | ||||||||
|
|
||||||||
| 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 a maximum of 60 minutes. | ||||||||
|
Member
There was a problem hiding this comment. This will no longer be the case once CAE is enabled. We'd better not mention such implementation detail. The user should always check the Also see #19700 |
||||||||
| If the subscription argument isn't specified, the current account is used. | ||||||||
| examples: | ||||||||
| - name: Get an access token information for the current account. | ||||||||
| text: az account get-access-token | ||||||||
| - name: Get an access token information for a specific subscription. | ||||||||
| text: az account get-access-token --subscription MySubscriptionID | ||||||||
| - name: Get an access token information for a specific tenant. | ||||||||
| text: az account get-access-token --tenant MySubscriptionID | ||||||||
| - name: Get an access token information to use with MS Graph API. | ||||||||
| text: az account get-access-token --resource-type ms-graph | ||||||||
| - name: Get an access token information for a particular resource. If you receive a `Failed to connect to MSI...` error, your resource may not exist. | ||||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||||
| text: > | ||||||||
| az account get-access-token --resource MyResourceID | ||||||||
|
Comment on lines
+122
to
+123
Member
There was a problem hiding this comment.
Suggested change
|
||||||||
| - name: Get only the access token for a particular resource returning results in plain text. This script is useful when you want to store the token in a variable. | ||||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||||
| text: az account get-access-token --resource https://management.core.windows.net/ --query accessToken --output tsv | ||||||||
| - name: Get an access token for a particular scope | ||||||||
|
Member
There was a problem hiding this comment.
Suggested change
We may make it consistent with other examples. |
||||||||
| text: az account get-access-token --scope https://management.azure.com//.default | ||||||||
| """ | ||||||||
|
|
||||||||
| helps['self-test'] = """ | ||||||||
|
|
||||||||
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.
We now recommend using tenant ID, instead of domain name, as domain name requires extra resolution (#10418):
azure-cli/src/azure-cli/azure/cli/command_modules/profile/_validators.py
Lines 12 to 31 in a7afdf1