Add AzureCloudShell detection and improve user prompts for device login (#4997)

gautamdsheth · Gautam Sheth · web-flow · commit 6d5c51c1af00 · 2025-07-05T17:09:55.000+03:00
Co-authored-by: Gautam Sheth &lt;gautam.sheth@staffbase.com&gt;
diff --git a/src/Commands/AzureAD/RegisterAzureADApp.cs b/src/Commands/AzureAD/RegisterAzureADApp.cs
@@ -659,15 +659,22 @@ private void StartConsentFlow(string loginEndPoint, AzureADApp azureApp, string
                 {
                     using (var authManager = AuthenticationManager.CreateWithDeviceLogin(azureApp.AppId, Tenant, (deviceCodeResult) =>
                     {
-                        try
+                        if (PSUtility.IsAzureCloudShell())
                         {
-                            ClipboardService.SetText(deviceCodeResult.UserCode);
+                            Host.UI.WriteWarningLine($"\n\nTo sign in, use a web browser to open the page {deviceCodeResult.VerificationUrl} and enter the code {deviceCodeResult.UserCode} to authenticate.");
                         }
-                        catch
+                        else
                         {
+                            try
+                            {
+                                ClipboardService.SetText(deviceCodeResult.UserCode);
+                            }
+                            catch
+                            {
+                            }
+                            Host.UI.WriteWarningLine($"\n\nPlease login.\n\nWe opened a browser and navigated to {deviceCodeResult.VerificationUrl}\n\nEnter code: {deviceCodeResult.UserCode} (we copied this code to your clipboard)\n\nNOTICE: close the browser tab after you authenticated successfully to continue the process.");
+                            BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);
                         }
-                        Host.UI.WriteWarningLine($"\n\nPlease login.\n\nWe opened a browser and navigated to {deviceCodeResult.VerificationUrl}\n\nEnter code: {deviceCodeResult.UserCode} (we copied this code to your clipboard)\n\nNOTICE: close the browser tab after you authenticated successfully to continue the process.");
-                        BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);
                         return Task.FromResult(0);
                     }, AzureEnvironment))
                     {
diff --git a/src/Commands/AzureAD/RegisterEntraIDAppForInteractiveLogin.cs b/src/Commands/AzureAD/RegisterEntraIDAppForInteractiveLogin.cs
@@ -500,15 +500,22 @@ private void StartConsentFlow(string loginEndPoint, AzureADApp azureApp, string
                 {
                     using (var authManager = AuthenticationManager.CreateWithDeviceLogin(azureApp.AppId, Tenant, (deviceCodeResult) =>
                     {
-                        try
+                        if (PSUtility.IsAzureCloudShell())
                         {
-                            ClipboardService.SetText(deviceCodeResult.UserCode);
+                            Host.UI.WriteWarningLine($"\n\nTo sign in, use a web browser to open the page {deviceCodeResult.VerificationUrl} and enter the code {deviceCodeResult.UserCode} to authenticate.");
                         }
-                        catch
+                        else
                         {
+                            try
+                            {
+                                ClipboardService.SetText(deviceCodeResult.UserCode);
+                            }
+                            catch
+                            {
+                            }
+                            Host.UI.WriteWarningLine($"\n\nPlease login.\n\nWe opened a browser and navigated to {deviceCodeResult.VerificationUrl}\n\nEnter code: {deviceCodeResult.UserCode} (we copied this code to your clipboard)\n\nNOTICE: close the browser tab after you authenticated successfully to continue the process.");
+                            BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);
                         }
-                        Host.UI.WriteWarningLine($"\n\nPlease login.\n\nWe opened a browser and navigated to {deviceCodeResult.VerificationUrl}\n\nEnter code: {deviceCodeResult.UserCode} (we copied this code to your clipboard)\n\nNOTICE: close the browser tab after you authenticated successfully to continue the process.");
-                        BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);
                         return Task.FromResult(0);
                     }, AzureEnvironment))
                     {
diff --git a/src/Commands/Base/PnPConnection.cs b/src/Commands/Base/PnPConnection.cs
@@ -280,15 +280,22 @@ internal static PnPConnection CreateWithDeviceLogin(string clientId, string url,
             {
                 authManager = Framework.AuthenticationManager.CreateWithDeviceLogin(clientId, tenantId, (deviceCodeResult) =>
                  {
-                     try
+                     if (PSUtility.IsAzureCloudShell())
                      {
-                         ClipboardService.SetText(deviceCodeResult.UserCode);
+                         messageWriter.LogWarning($"\n\nTo sign in, use a web browser to open the page {deviceCodeResult.VerificationUrl} and enter the code {deviceCodeResult.UserCode} to authenticate.\n\n");
                      }
-                     catch
+                     else
                      {
+                         try
+                         {
+                             ClipboardService.SetText(deviceCodeResult.UserCode);
+                         }
+                         catch
+                         {
+                         }
+                         messageWriter.LogWarning($"\n\nCode {deviceCodeResult.UserCode} has been copied to your clipboard and a new tab in the browser has been opened. Please paste this code in there and proceed.\n\n");
+                         BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);
                      }
-                     messageWriter.LogWarning($"\n\nCode {deviceCodeResult.UserCode} has been copied to your clipboard and a new tab in the browser has been opened. Please paste this code in there and proceed.\n\n");
-                     BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);
 
                      return Task.FromResult(0);
                  }, azureEnvironment, tokenCacheCallback: async (tokenCache) =>
diff --git a/src/Commands/Utilities/AzureAuthHelper.cs b/src/Commands/Utilities/AzureAuthHelper.cs
@@ -32,12 +32,24 @@ internal static string AuthenticateDeviceLogin(CancellationTokenSource cancellat
         {
             try
             {
-                using (var authManager = PnP.Framework.AuthenticationManager.CreateWithDeviceLogin(CLIENTID, (result) =>
+                using (var authManager = AuthenticationManager.CreateWithDeviceLogin(CLIENTID, (deviceCodeResult) =>
                 {
-
-                    ClipboardService.SetText(result.UserCode);
-                    messageWriter.LogWarning($"Please login.\n\nWe opened a browser and navigated to {result.VerificationUrl}\n\nEnter code: {result.UserCode} (we copied this code to your clipboard)\n\nNOTICE: close the browser tab after you authenticated successfully to continue the process.");
-                    BrowserHelper.OpenBrowserForInteractiveLogin(result.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);
+                    if (PSUtility.IsAzureCloudShell())
+                    {
+                        messageWriter.LogWarning($"\n\nTo sign in, use a web browser to open the page {deviceCodeResult.VerificationUrl} and enter the code {deviceCodeResult.UserCode} to authenticate.");
+                    }
+                    else
+                    {
+                        try
+                        {
+                            ClipboardService.SetText(deviceCodeResult.UserCode);
+                        }
+                        catch
+                        {
+                        }
+                        messageWriter.LogWarning($"Please login.\n\nWe opened a browser and navigated to {deviceCodeResult.VerificationUrl}\n\nEnter code: {deviceCodeResult.UserCode} (we copied this code to your clipboard)\n\nNOTICE: close the browser tab after you authenticated successfully to continue the process.");
+                        BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);
+                    }
 
                     return Task.FromResult(0);
                 }, azureEnvironment))
diff --git a/src/Commands/Utilities/PSUtility.cs b/src/Commands/Utilities/PSUtility.cs
@@ -50,5 +50,16 @@ public static bool IsUserLocalAdmin()
             return true;
         }
 #pragma warning restore CA1416 // Validate platform compatibility
+
+        public static bool IsAzureCloudShell()
+        {
+            string psDistChannel = Environment.GetEnvironmentVariable("POWERSHELL_DISTRIBUTION_CHANNEL");
+            if (string.IsNullOrWhiteSpace(psDistChannel))
+            {
+                return false;
+            }
+
+            return psDistChannel == "CloudShell";
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -659,15 +659,22 @@ private void StartConsentFlow(string loginEndPoint, AzureADApp azureApp, string`
`659`	`659`	`{`
`660`	`660`	`using (var authManager = AuthenticationManager.CreateWithDeviceLogin(azureApp.AppId, Tenant, (deviceCodeResult) =>`
`661`	`661`	`{`
`662`		`- try`
	`662`	`+ if (PSUtility.IsAzureCloudShell())`
`663`	`663`	`{`
`664`		`- ClipboardService.SetText(deviceCodeResult.UserCode);`
	`664`	`+ Host.UI.WriteWarningLine($"\n\nTo sign in, use a web browser to open the page {deviceCodeResult.VerificationUrl} and enter the code {deviceCodeResult.UserCode} to authenticate.");`
`665`	`665`	`}`
`666`		`- catch`
	`666`	`+ else`
`667`	`667`	`{`
	`668`	`+ try`
	`669`	`+ {`
	`670`	`+ ClipboardService.SetText(deviceCodeResult.UserCode);`
	`671`	`+ }`
	`672`	`+ catch`
	`673`	`+ {`
	`674`	`+ }`
	`675`	`+ Host.UI.WriteWarningLine($"\n\nPlease login.\n\nWe opened a browser and navigated to {deviceCodeResult.VerificationUrl}\n\nEnter code: {deviceCodeResult.UserCode} (we copied this code to your clipboard)\n\nNOTICE: close the browser tab after you authenticated successfully to continue the process.");`
	`676`	`+ BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);`
`668`	`677`	`}`
`669`		`- Host.UI.WriteWarningLine($"\n\nPlease login.\n\nWe opened a browser and navigated to {deviceCodeResult.VerificationUrl}\n\nEnter code: {deviceCodeResult.UserCode} (we copied this code to your clipboard)\n\nNOTICE: close the browser tab after you authenticated successfully to continue the process.");`
`670`		`- BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);`
`671`	`678`	`return Task.FromResult(0);`
`672`	`679`	`}, AzureEnvironment))`
`673`	`680`	`{`
Original file line number	Diff line number	Diff line change
`@@ -500,15 +500,22 @@ private void StartConsentFlow(string loginEndPoint, AzureADApp azureApp, string`
`500`	`500`	`{`
`501`	`501`	`using (var authManager = AuthenticationManager.CreateWithDeviceLogin(azureApp.AppId, Tenant, (deviceCodeResult) =>`
`502`	`502`	`{`
`503`		`- try`
	`503`	`+ if (PSUtility.IsAzureCloudShell())`
`504`	`504`	`{`
`505`		`- ClipboardService.SetText(deviceCodeResult.UserCode);`
	`505`	`+ Host.UI.WriteWarningLine($"\n\nTo sign in, use a web browser to open the page {deviceCodeResult.VerificationUrl} and enter the code {deviceCodeResult.UserCode} to authenticate.");`
`506`	`506`	`}`
`507`		`- catch`
	`507`	`+ else`
`508`	`508`	`{`
	`509`	`+ try`
	`510`	`+ {`
	`511`	`+ ClipboardService.SetText(deviceCodeResult.UserCode);`
	`512`	`+ }`
	`513`	`+ catch`
	`514`	`+ {`
	`515`	`+ }`
	`516`	`+ Host.UI.WriteWarningLine($"\n\nPlease login.\n\nWe opened a browser and navigated to {deviceCodeResult.VerificationUrl}\n\nEnter code: {deviceCodeResult.UserCode} (we copied this code to your clipboard)\n\nNOTICE: close the browser tab after you authenticated successfully to continue the process.");`
	`517`	`+ BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);`
`509`	`518`	`}`
`510`		`- Host.UI.WriteWarningLine($"\n\nPlease login.\n\nWe opened a browser and navigated to {deviceCodeResult.VerificationUrl}\n\nEnter code: {deviceCodeResult.UserCode} (we copied this code to your clipboard)\n\nNOTICE: close the browser tab after you authenticated successfully to continue the process.");`
`511`		`- BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);`
`512`	`519`	`return Task.FromResult(0);`
`513`	`520`	`}, AzureEnvironment))`
`514`	`521`	`{`
Original file line number	Diff line number	Diff line change
`@@ -280,15 +280,22 @@ internal static PnPConnection CreateWithDeviceLogin(string clientId, string url,`
`280`	`280`	`{`
`281`	`281`	`authManager = Framework.AuthenticationManager.CreateWithDeviceLogin(clientId, tenantId, (deviceCodeResult) =>`
`282`	`282`	`{`
`283`		`- try`
	`283`	`+ if (PSUtility.IsAzureCloudShell())`
`284`	`284`	`{`
`285`		`- ClipboardService.SetText(deviceCodeResult.UserCode);`
	`285`	`+ messageWriter.LogWarning($"\n\nTo sign in, use a web browser to open the page {deviceCodeResult.VerificationUrl} and enter the code {deviceCodeResult.UserCode} to authenticate.\n\n");`
`286`	`286`	`}`
`287`		`- catch`
	`287`	`+ else`
`288`	`288`	`{`
	`289`	`+ try`
	`290`	`+ {`
	`291`	`+ ClipboardService.SetText(deviceCodeResult.UserCode);`
	`292`	`+ }`
	`293`	`+ catch`
	`294`	`+ {`
	`295`	`+ }`
	`296`	`+ messageWriter.LogWarning($"\n\nCode {deviceCodeResult.UserCode} has been copied to your clipboard and a new tab in the browser has been opened. Please paste this code in there and proceed.\n\n");`
	`297`	`+ BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);`
`289`	`298`	`}`
`290`		`- messageWriter.LogWarning($"\n\nCode {deviceCodeResult.UserCode} has been copied to your clipboard and a new tab in the browser has been opened. Please paste this code in there and proceed.\n\n");`
`291`		`- BrowserHelper.OpenBrowserForInteractiveLogin(deviceCodeResult.VerificationUrl, BrowserHelper.FindFreeLocalhostRedirectUri(), cancellationTokenSource);`
`292`	`299`
`293`	`300`	`return Task.FromResult(0);`
`294`	`301`	`}, azureEnvironment, tokenCacheCallback: async (tokenCache) =>`
Original file line number	Diff line number	Diff line change
`@@ -50,5 +50,16 @@ public static bool IsUserLocalAdmin()`
`50`	`50`	`return true;`
`51`	`51`	`}`
`52`	`52`	`#pragma warning restore CA1416 // Validate platform compatibility`
	`53`	`+`
	`54`	`+ public static bool IsAzureCloudShell()`
	`55`	`+ {`
	`56`	`+ string psDistChannel = Environment.GetEnvironmentVariable("POWERSHELL_DISTRIBUTION_CHANNEL");`
	`57`	`+ if (string.IsNullOrWhiteSpace(psDistChannel))`
	`58`	`+ {`
	`59`	`+ return false;`
	`60`	`+ }`
	`61`	`+`
	`62`	`+ return psDistChannel == "CloudShell";`
	`63`	`+ }`
`53`	`64`	`}`
`54`	`65`	`}`