[Profile] `az login`: Add post-output hint by jiasli · Pull Request #27916 · Azure/azure-cli

jiasli · 2023-11-24T10:01:23Z

Related command
az login

Description
This PR is a simplified version of #16242:

The hinter is only registered on az login. No extra command module hint is introduced.
The different logic for handling subscription and tenant accounts is removed. All accounts are treated as subscriptions, differentiated by N/A(tenant level account). This is because the "dummy subscription representing a tenant" is already a bad design, so I don't want to spend too much effort explaining the intricacy. (See below for additional information.)
Subscription ID is always shown.
The TRY part is omitted.

Explanations:

The hint is printed to stderr, so it won't corrupt the JSON printed to stdout.
The default subscription hint may become invalid if az login should not select the default subscription #27915 is implemented.

Testing Guide
With subscription access:

> az login --service-principal --username a7003d8c-e50f-4371-91a6-ef37bba4ab23 --password xxx --tenant 54826b22-38d6-4fb2-bad9-b7b93a3e9c5a --allow-no-subscriptions
[
  {
    "cloudName": "AzureCloud",
    "homeTenantId": "54826b22-38d6-4fb2-bad9-b7b93a3e9c5a",
    "id": "0b1f6471-1bf0-4dda-aec3-cb9272f09590",
    "isDefault": true,
    "managedByTenants": [],
    "name": "AzureSDKTest",
    "state": "Enabled",
    "tenantId": "54826b22-38d6-4fb2-bad9-b7b93a3e9c5a",
    "user": {
      "name": "a7003d8c-e50f-4371-91a6-ef37bba4ab23",
      "type": "servicePrincipal"
    }
  }
]
[HINT]
The default subscription is 0b1f6471-1bf0-4dda-aec3-cb9272f09590 (AzureSDKTest)
To change the default subscription, run `az account set --subscription {id or name}`

Without subscription access:

> az login --service-principal --username 92375e31-0eae-4019-8207-0698ce16d144 --password xxx --tenant 54826b22-38d6-4fb2-bad9-b7b93a3e9c5a --allow-no-subscriptions
[
  {
    "cloudName": "AzureCloud",
    "id": "54826b22-38d6-4fb2-bad9-b7b93a3e9c5a",
    "isDefault": true,
    "name": "N/A(tenant level account)",
    "state": "Enabled",
    "tenantId": "54826b22-38d6-4fb2-bad9-b7b93a3e9c5a",
    "user": {
      "name": "92375e31-0eae-4019-8207-0698ce16d144",
      "type": "servicePrincipal"
    }
  }
]
[HINT]
The default subscription is 54826b22-38d6-4fb2-bad9-b7b93a3e9c5a (N/A(tenant level account))
To change the default subscription, run `az account set --subscription {id or name}`

Additional information

There is no concept of tenant account at all. There is only "dummy subscription representing a tenant". The help message of az account set shows the same:

> az account set -h

Command
    az account set : Set a subscription to be the current active subscription.

Arguments
    --name --subscription -n -s [Required] : Name or ID of subscription.

Related discussions:

azure-client-tools-bot-prd · 2023-11-24T10:01:26Z

️✔️AzureCLI-FullTest

️✔️acr

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️acs

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️advisor

️✔️latest

️✔️3.11

️✔️3.9

️✔️ams

️✔️latest

️✔️3.11

️✔️3.9

️✔️apim

️✔️latest

️✔️3.11

️✔️3.9

️✔️appconfig

️✔️latest

️✔️3.11

️✔️3.9

️✔️appservice

️✔️latest

️✔️3.11

️✔️3.9

️✔️aro

️✔️latest

️✔️3.11

️✔️3.9

️✔️backup

️✔️latest

️✔️3.11

️✔️3.9

️✔️batch

️✔️latest

️✔️3.11

️✔️3.9

️✔️batchai

️✔️latest

️✔️3.11

️✔️3.9

️✔️billing

️✔️latest

️✔️3.11

️✔️3.9

️✔️botservice

️✔️latest

️✔️3.11

️✔️3.9

️✔️cdn

️✔️latest

️✔️3.11

️✔️3.9

️✔️cloud

️✔️latest

️✔️3.11

️✔️3.9

️✔️cognitiveservices

️✔️latest

️✔️3.11

️✔️3.9

️✔️config

️✔️latest

️✔️3.11

️✔️3.9

️✔️configure

️✔️latest

️✔️3.11

️✔️3.9

️✔️consumption

️✔️latest

️✔️3.11

️✔️3.9

️✔️container

️✔️latest

️✔️3.11

️✔️3.9

️✔️containerapp

️✔️latest

️✔️3.11

️✔️3.9

️✔️core

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️cosmosdb

️✔️latest

️✔️3.11

️✔️3.9

️✔️databoxedge

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️dla

️✔️latest

️✔️3.11

️✔️3.9

️✔️dls

️✔️latest

️✔️3.11

️✔️3.9

️✔️dms

️✔️latest

️✔️3.11

️✔️3.9

️✔️eventgrid

️✔️latest

️✔️3.11

️✔️3.9

️✔️eventhubs

️✔️latest

️✔️3.11

️✔️3.9

️✔️feedback

️✔️latest

️✔️3.11

️✔️3.9

️✔️find

️✔️latest

️✔️3.11

️✔️3.9

️✔️hdinsight

️✔️latest

️✔️3.11

️✔️3.9

️✔️identity

️✔️latest

️✔️3.11

️✔️3.9

️✔️iot

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️keyvault

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️kusto

️✔️latest

️✔️3.11

️✔️3.9

️✔️lab

️✔️latest

️✔️3.11

️✔️3.9

️✔️managedservices

️✔️latest

️✔️3.11

️✔️3.9

️✔️maps

️✔️latest

️✔️3.11

️✔️3.9

️✔️marketplaceordering

️✔️latest

️✔️3.11

️✔️3.9

️✔️monitor

️✔️latest

️✔️3.11

️✔️3.9

️✔️mysql

️✔️latest

️✔️3.11

️✔️3.9

️✔️netappfiles

️✔️latest

️✔️3.11

️✔️3.9

️✔️network

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️policyinsights

️✔️latest

️✔️3.11

️✔️3.9

️✔️privatedns

️✔️latest

️✔️3.11

️✔️3.9

️✔️profile

️✔️latest

️✔️3.11

️✔️3.9

️✔️rdbms

️✔️latest

️✔️3.11

️✔️3.9

️✔️redis

️✔️latest

️✔️3.11

️✔️3.9

️✔️relay

️✔️latest

️✔️3.11

️✔️3.9

️✔️resource

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️role

️✔️latest

️✔️3.11

️✔️3.9

️✔️search

️✔️latest

️✔️3.11

️✔️3.9

️✔️security

️✔️latest

️✔️3.11

️✔️3.9

️✔️servicebus

️✔️latest

️✔️3.11

️✔️3.9

️✔️serviceconnector

️✔️latest

️✔️3.11

️✔️3.9

️✔️servicefabric

️✔️latest

️✔️3.11

️✔️3.9

️✔️signalr

️✔️latest

️✔️3.11

️✔️3.9

️✔️sql

️✔️latest

️✔️3.11

️✔️3.9

️✔️sqlvm

️✔️latest

️✔️3.11

️✔️3.9

️✔️storage

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️synapse

️✔️latest

️✔️3.11

️✔️3.9

️✔️telemetry

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

️✔️util

️✔️latest

️✔️3.11

️✔️3.9

️✔️vm

️✔️2018-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2019-03-01-hybrid

️✔️3.11

️✔️3.9

️✔️2020-09-01-hybrid

️✔️3.11

️✔️3.9

️✔️latest

️✔️3.11

️✔️3.9

azure-client-tools-bot-prd · 2023-11-24T10:01:29Z

Hi @jiasli,
Since the current milestone time is less than 7 days, this pr will be reviewed in the next milestone.

azure-client-tools-bot-prd · 2023-11-24T10:01:32Z

️✔️AzureCLI-BreakingChangeTest

️✔️Non Breaking Changes

jiasli · 2023-11-24T10:30:36Z

#16242 emphasizes subscription name instead of subscription ID. If name can uniquely identify the default subscription, only show name; Otherwise, name is appended with id wrapped by parentheses:

Subscription name is unique: AzureSDKTest
Subscription name is not unique: AzureSDKTest (0b1f6471-1bf0-4dda-aec3-cb9272f09590)

I personally don't agree with this design, as subscription ID is

globally unique
constant (can't be changed)
the primary key to identify a subscription in resource ID, such as /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590

On the other hand, subscription name is

not unique
can be changed at will
only for displaying purpose and not programmatically used anywhere

Azure CLI as an automation tool should focus on automation scenarios, instead of readability when they conflict.

login-hint

99af623

azure-client-tools-bot-prd bot added this to the December 2023 (2024-01-02) milestone Nov 24, 2023

microsoft-github-policy-service bot requested a review from zhoxing-ms November 24, 2023 10:01

microsoft-github-policy-service bot requested a review from yonzhan November 24, 2023 10:01

microsoft-github-policy-service bot added the Auto-Assign Auto assign by bot label Nov 24, 2023

microsoft-github-policy-service bot assigned zhoxing-ms Nov 24, 2023

microsoft-github-policy-service bot added the ARM az resource/group/lock/tag/deployment/policy/managementapp/account management-group label Nov 24, 2023

microsoft-github-policy-service bot assigned jiasli Nov 24, 2023

microsoft-github-policy-service bot added the Account az login/account label Nov 24, 2023

yonzhan unassigned zhoxing-ms Nov 25, 2023

Merge remote-tracking branch 'azure/dev' into login-hint

30daa0e

yonzhan modified the milestones: December 2023 (2024-01-09), January 2024 (2024-02-06) Jan 2, 2024

yonzhan modified the milestones: January 2024 (2024-02-06), February 2024 (2024-03-05) Jan 29, 2024

yonzhan modified the milestones: February 2024 (2024-03-05), March 2024 (2024-04-02) Feb 27, 2024

jiasli modified the milestones: March 2024 (2024-04-02), Backlog Mar 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Profile] `az login`: Add post-output hint#27916

[Profile] `az login`: Add post-output hint#27916
jiasli wants to merge 2 commits intoAzure:devfrom
jiasli:login-hint

jiasli commented Nov 24, 2023

Uh oh!

azure-client-tools-bot-prd bot commented Nov 24, 2023 •

edited

Loading

Uh oh!

azure-client-tools-bot-prd bot commented Nov 24, 2023

Uh oh!

azure-client-tools-bot-prd bot commented Nov 24, 2023 •

edited

Loading

Uh oh!

jiasli commented Nov 24, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jiasli commented Nov 24, 2023

Uh oh!

azure-client-tools-bot-prd bot commented Nov 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-client-tools-bot-prd bot commented Nov 24, 2023

Uh oh!

azure-client-tools-bot-prd bot commented Nov 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jiasli commented Nov 24, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

azure-client-tools-bot-prd bot commented Nov 24, 2023 •

edited

Loading

azure-client-tools-bot-prd bot commented Nov 24, 2023 •

edited

Loading