[Az.Accounts] Support Login Hint (#16337)

* Support Login Hint

1. AccountId is passed to Azure.Identity as LoginHint when interactively
login
2. LoginHint will be serialized to Context.json but not used
3. LoginHint can be found in the following request
   - GET https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize?scope=https%3A%2F%2Fmanagement.core.windows.net%2F%2F.default+openid+profile+offline_access&response_type=code&client_id=1950a258-227b-4e31-a9cf-717495945fc2&redirect_uri=http%3A%2F%2Flocalhost%3A8400%2F&claims=%7B%22access_token%22%3A%7B%22xms_cc%22%3A%7B%22values%22%3A%5B%22CP1%22%5D%7D%7D%7D&login_hint=leijin%40microsoft.com&client-request-id=161db891-d34f-4eb6-a0e2-c9f3998211f2&x-client-SKU=MSAL.NetCore&x-client-Ver=4.30.1.0&x-client-CPU=x64&x-client-OS=Microsoft+Windows+10.0.19043&code_challenge=xxxxxxxxxxxxxxxxxxxxxx&code_challenge_method=S256&state=b2ccf0cc-8216-4a25-97d4-136c8c0fc4030d6bd724-b75b-49ba-a7c3-665682eaeeda HTTP/1.1

* Address review comments

Author: msJinLei

src/Accounts/Accounts/Account/ConnectAzureRmAccount.cs

@@ -47,7 +47,7 @@ namespace Microsoft.Azure.Commands.Profile
     /// <summary>
     /// Cmdlet to log into an environment and download the subscriptions
     /// </summary>
-    [Cmdlet("Connect", AzureRMConstants.AzureRMPrefix + "Account", DefaultParameterSetName = "UserWithSubscriptionId", SupportsShouldProcess=true)]
+    [Cmdlet("Connect", AzureRMConstants.AzureRMPrefix + "Account", DefaultParameterSetName = UserParameterSet, SupportsShouldProcess=true)]
     [Alias("Login-AzAccount", "Login-AzureRmAccount", "Add-" + AzureRMConstants.AzureRMPrefix + "Account")]
     [OutputType(typeof(PSAzureProfile))]
     public class ConnectAzureRmAccountCommand : AzureContextModificationCmdlet, IModuleAssemblyInitializer
@@ -137,6 +137,8 @@ public class ConnectAzureRmAccountCommand : AzureContextModificationCmdlet, IMod
         [ValidateNotNullOrEmpty]
         public string KeyVaultAccessToken { get; set; }
 
+        [Parameter(ParameterSetName = UserParameterSet,
+            Mandatory = false, HelpMessage = "Account Id / User Id / User Name to login with")]
         [Parameter(ParameterSetName = AccessTokenParameterSet,
                     Mandatory = true, HelpMessage = "Account Id for access token")]
         [Parameter(ParameterSetName = ManagedServiceParameterSet,
@@ -323,6 +325,13 @@ public override void ExecuteCmdlet()
 
             switch (ParameterSetName)
             {
+                case UserParameterSet:
+                    azureAccount.Type = AzureAccount.AccountType.User;
+                    if(!string.IsNullOrEmpty(AccountId))
+                    {
+                        azureAccount.SetProperty("LoginHint", AccountId);
+                    }
+                    break;
                 case AccessTokenParameterSet:
                     azureAccount.Type = AzureAccount.AccountType.AccessToken;
                     azureAccount.Id = AccountId;

src/Accounts/Accounts/ChangeLog.md

@@ -19,6 +19,7 @@
 -->
 
 ## Upcoming Release
+* Supported login hint
 * Added Environment auto completer to the following cmdlets: Connect-AzAccount, Get-AzEnvironment, Set-AzEnvironment, and Remove-AzEnvironment [#15991]
 
 ## Version 2.6.1

src/Accounts/Accounts/help/Connect-AzAccount.md

@@ -14,10 +14,10 @@ Connect to Azure with an authenticated account for use with cmdlets from the Az
 
 ### UserWithSubscriptionId (Default)
 ```
-Connect-AzAccount [-Environment <String>] [-Tenant <String>] [-Subscription <String>] [-AuthScope <String>]
- [-ContextName <String>] [-SkipContextPopulation] [-MaxContextPopulation <Int32>] [-UseDeviceAuthentication]
- [-Force] [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
- [<CommonParameters>]
+Connect-AzAccount [-Environment <String>] [-Tenant <String>] [-AccountId <String>] [-Subscription <String>]
+ [-AuthScope <String>] [-ContextName <String>] [-SkipContextPopulation] [-MaxContextPopulation <Int32>]
+ [-UseDeviceAuthentication] [-Force] [-Scope <ContextModificationScope>]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ServicePrincipalWithSubscriptionId
@@ -275,16 +275,16 @@ Accept wildcard characters: False
 
 ### -AccountId
 
-Account ID for access token in **AccessToken** parameter set. Account ID for managed service in
+Account Id / User Id / User Name to login with in **Default (UserWithSubscriptionId)** parameter set; Account ID for access token in **AccessToken** parameter set; Account ID for managed service in
 **ManagedService** parameter set. Can be a managed service resource ID, or the associated client ID.
 To use the system assigned identity, leave this field blank.
 
 ```yaml
 Type: System.String
-Parameter Sets: AccessTokenWithSubscriptionId
+Parameter Sets: UserWithSubscriptionId, ManagedServiceLogin
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -293,10 +293,10 @@ Accept wildcard characters: False
 
 ```yaml
 Type: System.String
-Parameter Sets: ManagedServiceLogin
+Parameter Sets: AccessTokenWithSubscriptionId
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: None
 Accept pipeline input: False

src/Accounts/Accounts/help/Open-AzSurveyLink.md

@@ -13,7 +13,7 @@ Open survey link in default browser.
 ## SYNTAX
 
 ```
-Open-AzSurveyLink [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
+Open-AzSurveyLink [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -29,21 +29,6 @@ Opening the default browser to https://aka.ms/azpssurvey?Q_CHL=INTERCEPT
 
 ## PARAMETERS
 
-### -DefaultProfile
-The credentials, account, tenant, and subscription used for communication with Azure.
-
-```yaml
-Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
-Parameter Sets: (All)
-Aliases: AzContext, AzureRmContext, AzureCredential
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 

src/Accounts/Authentication/Authentication.csproj

@@ -12,7 +12,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Azure.Identity" Version="1.4.0" />
+    <PackageReference Include="Azure.Identity" Version="1.5.0" />
   </ItemGroup>
 
   <ItemGroup>
@@ -30,4 +30,4 @@
     </EmbeddedResource>
   </ItemGroup>
 
-</Project>
+</Project>

src/Accounts/Authentication/Factories/AuthenticationFactory.cs

@@ -545,8 +545,7 @@ private AuthenticationParameters GetAuthenticationParameters(
                         {
                             return new UsernamePasswordParameters(tokenCacheProvider, environment, tokenCache, tenant, resourceId, account.Id, password, homeAccountId);
                         }
-
-                        return new InteractiveParameters(tokenCacheProvider, environment, tokenCache, tenant, resourceId, account.Id, homeAccountId, promptAction);
+                        return new InteractiveParameters(tokenCacheProvider, environment, tokenCache, tenant, resourceId, account.GetProperty("LoginHint"), homeAccountId, promptAction);
                     }
 
                     return new UsernamePasswordParameters(tokenCacheProvider, environment, tokenCache, tenant, resourceId, account.Id, password, null);

src/Accounts/AuthenticationAssemblyLoadContext/AzAssemblyLoadContextInitializer.cs

@@ -32,7 +32,7 @@ static AzAssemblyLoadContextInitializer()
             var azSharedAssemblies = new Dictionary<string, Version>()
             {
                 {"Azure.Core", new Version("1.20.0.0")},
-                {"Azure.Identity", new Version("1.4.0.0")},
+                {"Azure.Identity", new Version("1.5.0.0")},
                 {"Microsoft.Bcl.AsyncInterfaces", new Version("1.0.0.0")},
                 {"Microsoft.Identity.Client", new Version("4.30.1.0") },
                 {"Microsoft.Identity.Client.Extensions.Msal", new Version("2.18.4.0") },

src/Accounts/Authenticators/Authenticators.csproj

@@ -23,7 +23,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Azure.Identity" Version="1.4.0" />
+    <PackageReference Include="Azure.Identity" Version="1.5.0" />
   </ItemGroup>
 
   <ItemGroup>

src/Accounts/Authenticators/InteractiveUserAuthenticator.cs

@@ -64,6 +64,7 @@ public override Task<IAccessToken> Authenticate(AuthenticationParameters paramet
                 TokenCachePersistenceOptions = tokenCacheProvider.GetTokenCachePersistenceOptions(),
                 AuthorityHost = new Uri(authority),
                 RedirectUri = GetReplyUrl(onPremise, interactiveParameters),
+                LoginHint = interactiveParameters.UserId,
             };
             var browserCredential = new InteractiveBrowserCredential(options);