[SSH] Changes to prompts and error messages (#22181)

* Make proxy download prompt a ShouldContinue

* Make relayInfo variable a private field in each cmdlet

* Fix error messages and prompt messages

Author: vthiebaut10

src/Ssh/Ssh/Common/SshBaseCmdlet.cs

@@ -40,9 +40,7 @@
 using Microsoft.Rest.Azure;
 using Microsoft.Azure.PowerShell.Cmdlets.Ssh.AzureClients;
 using Microsoft.Azure.PowerShell.Ssh.Helpers.HybridConnectivity;
-using System.Management.Automation.Host;
 using System.Management.Automation.Runspaces;
-using System.Collections.ObjectModel;
 using Microsoft.Azure.PowerShell.Ssh.Helpers.HybridCompute.Models;
 using Microsoft.Azure.PowerShell.Ssh.Helpers.HybridCompute;
 
@@ -67,7 +65,6 @@ public abstract class SshBaseCmdlet : AzureRMCmdlet
         protected internal bool deleteCert;
         protected internal string proxyPath;
         protected internal ProgressRecord record;
-        protected internal EndpointAccessResource relayInfo;
         protected internal bool createdServiceConfig;
 
         protected internal readonly string[] supportedResourceTypes = {
@@ -342,7 +339,7 @@ private ResourceManagementClient ResourceManagementClient
         [Parameter(Mandatory = false)]
         public virtual SwitchParameter PassThru { get; set; }
 
-        [Parameter(Mandatory = false, HelpMessage = "When connecting to an Arc resource, do not ask for confirmation before updating the Service Configuration of the Connection Endpoint to match the target port.")]
+        [Parameter(Mandatory = false, HelpMessage = "When connecting to Arc resources, do not prompt for confirmation before updating the Service Configuration of the Connection Endpoint to match the target port or to install Az.Ssh.ArcProxy module from Gallery, if needed.")]
         public SwitchParameter Force { get; set; }
 
         #endregion
@@ -528,28 +525,21 @@ protected internal string GetProxyPath()
 
             if (String.IsNullOrEmpty(proxyPath))
             {
-                Collection<ChoiceDescription> choices = new Collection<ChoiceDescription> { 
-                    new ChoiceDescription("N", "No"),
-                    new ChoiceDescription("Y", "Yes")
-                };
-
-                int userChoice = this.Host.UI.PromptForChoice(
-                    caption: Resources.InstallProxyModuleCaption,
-                    message: Resources.InstallProxyModuleMessage,
-                    choices: choices,
-                    defaultChoice: 0);
-                if (userChoice == 1)
+                string caption = "Install Az.Ssh.ArcProxy module from the PowerShell Gallery";
+                string query = Resources.InstallProxyModuleQuery;
+
+                if (Force || ShouldContinue(query, caption))
                 {
                     var installationResults = InvokeCommand.InvokeScript(
                         script: "Install-module Az.Ssh.ArcProxy -Repository PsGallery -Scope CurrentUser -MaximumVersion 1.9.9 -AllowClobber -Force",
                         useNewScope: true,
                         writeToPipeline: PipelineResultTypes.Error,
                         input: null,
                         args: null);
-                    
+
                     proxyPath = SearchForInstalledProxyPath();
                 }
-                
+
             }
 
             if (!String.IsNullOrEmpty(proxyPath)) { return proxyPath; }
@@ -752,18 +742,16 @@ private bool ServiceConfigurationMatchesTargetPort()
         private void CreateServiceConfiguration()
         {
             // If the user doesn't provide a port, they might be trying to connect to port 22 or a different port set on ssh_config.
-            string caption = Resources.ServiceConfigCreateConfirmCaptionDefaultPort;
+            string query = Resources.ServiceConfigCreateConfirmQueryDefaultPort;
             int port = 22;
             if (Port != null)
             {
                 port = Int32.Parse(Port);
-                caption = String.Format(Resources.ServiceConfigCreateConfirmCaptionExplicitPort, port);  
+                query = String.Format(Resources.ServiceConfigCreateConfirmQueryExplicitPort, port);
             }
 
-            string query = String.Format(Resources.ServiceConfigCreateConfirmQuery, port);
-
             // Need to come back to these messages
-            if (!Force.IsPresent && !ShouldContinue(caption, query))
+            if (!Force && !ShouldContinue(query, String.Format("Allow SSH connection to port {0}", port)))
             {
                 throw new AzPSApplicationException(String.Format(Resources.ServiceConfigCreateConfirmationDenied, port));
             }

src/Ssh/Ssh/Properties/Resources.Designer.cs

@@ -141,11 +141,8 @@
   <data name="FailedToListCredentials" xml:space="preserve">
     <value>ListCredentials operation failed with error: {0}</value>
   </data>
-  <data name="InstallProxyModuleCaption" xml:space="preserve">
-    <value>The required Az.Ssh.ArcProxy module is not installed in this machine. Would you like this cmdlet to attempt to install the Az.Ssh.ArcProxy module from the PowerShell Gallery in the current user scope?</value>
-  </data>
-  <data name="InstallProxyModuleMessage" xml:space="preserve">
-    <value>The Az.Ssh.Proxy PowerShell module must be installed on the client machine in order to connect to Azure Arc resources. Installing the module to this machine is a one time operation, and you can choose to do it manually. You can find the module in the PowerShell Gallery (see: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy).</value>
+  <data name="InstallProxyModuleQuery" xml:space="preserve">
+    <value>The Az.Ssh.Proxy PowerShell module must be installed on the client machine to connect to Azure Arc resources. Installing the module to this machine is a one time operation, and you can choose to do it manually. You can find the module in the PowerShell Gallery (see: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy). The required Az.Ssh.ArcProxy module is not installed in this machine. Would you like this cmdlet to attempt to install the Az.Ssh.ArcProxy module from the PowerShell Gallery in the current user scope?</value>
   </data>
   <data name="KeysDestinationFolderWithKeys" xml:space="preserve">
     <value>KeysDestinationFolder can't be used in conjunction with PublicKeyFile or PrivateKeyFile. All generated keys are saved in the same directory as provided keys.</value>
@@ -183,14 +180,11 @@
   <data name="ServiceConfigCreateConfirmationDenied" xml:space="preserve">
     <value>SSH connection is not enabled in the target port {0}.</value>
   </data>
-  <data name="ServiceConfigCreateConfirmCaptionDefaultPort" xml:space="preserve">
-    <value>Port 22 is not allowed for SSH connections in this resource. You must have owner or contributor roles in this resource to be able to change the service configuration. If you would like this cmdlet to update the Service Configuration to allow connections to a different port, please provide the -Port parameter or manually set up the Service Configuration.</value>
-  </data>
-  <data name="ServiceConfigCreateConfirmCaptionExplicitPort" xml:space="preserve">
-    <value>Port {0} is not allowed for SSH connections in this resource. You must have owner or contributor roles in this resource to be able to change the service configuration.</value>
+  <data name="ServiceConfigCreateConfirmQueryDefaultPort" xml:space="preserve">
+    <value>Port 22 is not allowed for SSH connections in this resource. You must have owner or contributor roles in this resource to be able to change the service configuration. If you would like this cmdlet to update the Service Configuration to allow connections to a different port, please provide the -Port parameter or manually set up the Service Configuration. Would you like to update the current Service Configuration in the endpoint to allow connections to port 22?</value>
   </data>
-  <data name="ServiceConfigCreateConfirmQuery" xml:space="preserve">
-    <value>Would you like to update the current Service Configuration in the endpoint to allow connections to port {0}?</value>
+  <data name="ServiceConfigCreateConfirmQueryExplicitPort" xml:space="preserve">
+    <value>Port {0} is not allowed for SSH connections in this resource. You must have owner or contributor roles in this resource to be able to change the service configuration. Would you like to update the current Service Configuration in the endpoint to allow connections to port {0}?</value>
   </data>
   <data name="ServiceConfigCreateForbidden" xml:space="preserve">
     <value>Client is not authorized to create or update the Service Configuration endpoint for {0} in the Resource Group {1}. This is an operation that must be performed by an account with Owner or Contributor role to allow SSH connections to the specified port {2}.</value>

src/Ssh/Ssh/Properties/Resources.resx

@@ -24,6 +24,7 @@
 using System.Threading;
 using System.Text.RegularExpressions;
 using Microsoft.Azure.Commands.Ssh.Properties;
+using Microsoft.Azure.PowerShell.Ssh.Helpers.HybridConnectivity.Models;
 
 namespace Microsoft.Azure.Commands.Ssh
 {
@@ -55,6 +56,7 @@ public override string KeysDestinationFolder
 
         #region fields
         private int rdpLocalPort;
+        private EndpointAccessResource relayInfo;
         #endregion
 
         #region constants
@@ -69,7 +71,7 @@ public override void ExecuteCmdlet()
             ValidateParameters();
             SetResourceType();
 
-            record = new ProgressRecord(0, "Prepare for starting SSH connection", "Start Preparing");
+            record = new ProgressRecord(0, "Preparing for SSH connection", "Initiating connection setup");
             UpdateProgressBar(record, "Setup SSH connection", 0);
 
             if (!IsArc() && !ParameterSetName.Equals(IpAddressParameterSet))

src/Ssh/Ssh/SshCommands/EnterAzVMCommand.cs

@@ -79,7 +79,7 @@ public override void ExecuteCmdlet()
             {
                 CheckIfAgentIsUpToDate();
                 proxyPath = GetProxyPath();
-                UpdateProgressBar(record, $"Downloaded proxy to {proxyPath}", 25);
+                UpdateProgressBar(record, $"Retrieved path to Arc Proxy", 25);
                 EndpointAccessResource relayInfo = GetRelayInformation();
                 UpdateProgressBar(record, "Retrieved relay information", 50);
                 CreateRelayInfoFile(relayInfo);