Regional recommender (#21009)

* Region recommender

* west europe

* official common build

* limit the frequency of recommendation

* Revert "limit the frequency of recommendation"

...to align with CLI
This reverts commit 8abade1.

* changelog; null check; fix

* Parameter formatter for telemetry

* waiting for common

* new common build

Author: isra-fel

src/Accounts/Accounts/ChangeLog.md

@@ -22,6 +22,7 @@
 * Fixed the issue that errors related to WAM are thrown when it is not enabled. [#20871] [#20824]
 * Updated Azure.Core library to 1.28.0.
 * Fixed an issue that the helper message about missing modules shows up at the wrong time. [#19228]
+* Added a hint message for some resource creation cmdlets when there is another region which may reduce the costs.
 
 ## Version 2.11.2
 * Supported Web Account Manager on ARM64-based Windows systems. Fixed an issue where `Connect-AzAccount` failed with error "Unable to load DLL 'msalruntime_arm64'". [#20700]

src/Accounts/Authentication/AzureSessionInitializer.cs

@@ -32,6 +32,9 @@
 using TraceLevel = System.Diagnostics.TraceLevel;
 using System.Collections.Generic;
 using System.Threading;
+using Microsoft.WindowsAzure.Commands.Utilities.Common;
+using Microsoft.Azure.Commands.Common.Authentication.Utilities;
+using Microsoft.WindowsAzure.Commands.Common.Utilities;
 
 namespace Microsoft.Azure.Commands.Common.Authentication
 {
@@ -274,6 +277,11 @@ static IAzureSession CreateInstance(IDataStore dataStore = null, Action<string>
             InitializeConfigs(session, profilePath, writeWarning);
             InitializeDataCollection(session);
             session.RegisterComponent(HttpClientOperationsFactory.Name, () => HttpClientOperationsFactory.Create());
+
+            session.RegisterComponent<IEndProcessingRecommendationService>(nameof(IEndProcessingRecommendationService),
+                () => new DefaultRecommendationService());
+            session.RegisterComponent<IParameterTelemetryFormatter>(nameof(IParameterTelemetryFormatter),
+                () => new ParameterTelemetryFormatter());
             session.TokenCache = session.TokenCache ?? new AzureTokenCache();
             return session;
         }

src/Accounts/Authentication/Config/ConfigInitializer.cs

@@ -190,6 +190,12 @@ private void RegisterConfigs(IConfigManager configManager)
                 true,
                 AzurePSDataCollectionProfile.EnvironmentVariableName,
                 new[] { AppliesTo.Az }));
+            configManager.RegisterConfig(new SimpleTypedConfig<bool>(
+                ConfigKeys.DisplayRegionIdentified,
+                Resources.HelpMessageOfDisplayRegionIdentified,
+                true,
+                null,
+                new[] { AppliesTo.Az }));
 #if DEBUG || TESTCOVERAGE
             configManager.RegisterConfig(new SimpleTypedConfig<bool>(
                 ConfigKeys.EnableTestCoverage,

src/Accounts/Authentication/Properties/Resources.Designer.cs

@@ -383,4 +383,11 @@
   <data name="HelpMessageOfEnableWamLogin" xml:space="preserve">
     <value>[Preview] When enabled, Web Account Manager (WAM) will be the default interactive login experience. It will fall back to using the browser if the platform does not support WAM. Note that this feature is under preview. Microsoft Account (MSA) is currently not supported. Feel free to reach out to Azure PowerShell team if you have any feedbacks: https://aka.ms/azpsissue</value>
   </data>
+  <data name="RecommendationMessageForLocation" xml:space="preserve">
+    <value>Selecting “{0}” may reduce your costs. The region you’ve selected may cost more for the same services. You can disable this message in the future with the command “Update-AzConfig -DisplayRegionIdentified $false”. Learn more at https://go.microsoft.com/fwlink/?linkid=2225665</value>
+    <comment>0 = recommended location</comment>
+  </data>
+  <data name="HelpMessageOfDisplayRegionIdentified" xml:space="preserve">
+    <value>When enabled, Azure PowerShell displays recommendations on regions which may reduce your costs.</value>
+  </data>
 </root>

src/Accounts/Authentication/Properties/Resources.resx

@@ -0,0 +1,63 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using Microsoft.WindowsAzure.Commands.Utilities.Common;
+using System;
+using System.Collections.Generic;
+using System.Management.Automation;
+
+namespace Microsoft.Azure.Commands.Common.Authentication.Utilities
+{
+    /// <summary>
+    /// Default implementation of <see cref="IEndProcessingRecommendationService"/>
+    /// which provides suggestions based on cmdlet execution.
+    /// </summary>
+    internal class DefaultRecommendationService : IEndProcessingRecommendationService
+    {
+        private readonly IEnumerable<IRecommender> _recommenders;
+
+        public DefaultRecommendationService()
+        {
+            _recommenders = new List<IRecommender>()
+            {
+                new RegionalRecommender()
+            };
+        }
+
+        /// <inheritdoc/>
+        public override void Process(AzurePSCmdlet cmdlet, InvocationInfo invocation, AzurePSQoSEvent qosEvent)
+        {
+            foreach (var recommender in _recommenders)
+            {
+                try
+                {
+                    if (recommender.Process(invocation, qosEvent, out var recommendation))
+                    {
+                        WriteRecommendation(cmdlet, recommendation);
+                    }
+                }
+                catch (Exception ex)
+                {
+                    // swallow exceptions as recommendations are not vital
+                    cmdlet.WriteDebug($"[{nameof(DefaultRecommendationService)}] Error encountered: {ex.Message}.{Environment.NewLine}{ex.StackTrace}");
+                }
+            }
+        }
+
+        private void WriteRecommendation(AzurePSCmdlet cmdlet, string recommendation)
+        {
+            cmdlet.WriteInformation(new HostInformationMessage() { Message = recommendation }, new string[] { "PSHOST" });
+        }
+    }
+}

src/Accounts/Authentication/Utilities/Recommendation/DefaultRecommendationService.cs

@@ -0,0 +1,30 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using System.Management.Automation;
+
+namespace Microsoft.Azure.Commands.Common.Authentication.Utilities
+{
+    /// <summary>
+    /// Give recommendations based on cmdlet execution.
+    /// </summary>
+    internal interface IRecommender
+    {
+        /// <summary>
+        /// Process the cmdlet invocation, give recommendation if any. Update telemetry data if necessary.
+        /// </summary>
+        /// <returns>Whether there is a recommendation.</returns>
+        bool Process(InvocationInfo invocation, AzurePSQoSEvent qosEvent, out string recommendation);
+    }
+}

src/Accounts/Authentication/Utilities/Recommendation/IRecommender.cs

@@ -0,0 +1,81 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using Microsoft.Azure.Commands.Common.Authentication.Properties;
+using Microsoft.Azure.Commands.Shared.Config;
+using Microsoft.Azure.PowerShell.Common.Config;
+using System;
+using System.Collections.Generic;
+using System.Management.Automation;
+
+namespace Microsoft.Azure.Commands.Common.Authentication.Utilities
+{
+    /// <summary>
+    /// Giving recommendations based on the input location for resource creation.
+    /// </summary>
+    internal class RegionalRecommender : IRecommender
+    {
+        private readonly IDictionary<string, string> _regionMappings;
+
+        public RegionalRecommender()
+        {
+            _regionMappings = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase)
+            {
+                // to support both display name and code of any region,
+                // this map contains duplicated values
+                { "West Europe", "UK South" },
+                { "westeurope", "UK South" },
+                { "France Central", "North Europe" },
+                { "francecentral", "North Europe" },
+                { "Germany West Central", "North Europe" },
+                { "germanywestcentral", "North Europe" }
+            };
+        }
+
+        /// <inheritdoc/>
+        public bool Process(InvocationInfo invocation, AzurePSQoSEvent qosEvent, out string recommendation)
+        {
+            recommendation = null;
+
+            if (invocation?.MyCommand?.Name == null || invocation?.BoundParameters == null)
+            {
+                return false;
+            }
+
+
+            if (AzureSession.Instance.TryGetComponent<IConfigManager>(nameof(IConfigManager), out var configManager))
+            {
+                if (!configManager.GetConfigValue<bool>(ConfigKeys.DisplayRegionIdentified))
+                {
+                    return false;
+                }
+            }
+
+            if (string.Equals("New-AzVM", invocation?.MyCommand.Name, StringComparison.InvariantCultureIgnoreCase)
+                && invocation.BoundParameters.TryGetValue("Location", out object x)
+                && x is string inputLocation)
+            {
+                inputLocation = inputLocation.Trim();
+
+                if (_regionMappings.TryGetValue(inputLocation, out string recommendedLocation))
+                {
+                    recommendation = string.Format(Resources.RecommendationMessageForLocation, recommendedLocation);
+                    qosEvent.DisplayRegionIdentified = recommendedLocation;
+                    return true;
+                }
+            }
+            return false;
+        }
+    }
+}

src/Accounts/Authentication/Utilities/Recommendation/RegionalRecommender.cs

@@ -0,0 +1,54 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using Microsoft.WindowsAzure.Commands.Common.Utilities;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Management.Automation;
+
+namespace Microsoft.Azure.Commands.Common.Authentication.Utilities
+{
+    /// <inheritdoc/>
+    internal class ParameterTelemetryFormatter : IParameterTelemetryFormatter
+    {
+        /// <inheritdoc/>
+        public string FormatParameters(InvocationInfo invocation)
+        {
+            if (invocation?.BoundParameters == null) return string.Empty;
+
+            return string.Join(" ",
+                invocation.BoundParameters.Select(pair =>
+                    ShouldKeepValue(invocation, pair.Key)
+                    ? FormatParameterWithValue(pair.Key, pair.Value)
+                    : FormatParameterWithMaskedValue(pair.Key, pair.Value)));
+        }
+
+        private bool ShouldKeepValue(InvocationInfo invocation, string name)
+        {
+            return string.Equals("New-AzVM", invocation.MyCommand?.Name, StringComparison.InvariantCultureIgnoreCase)
+                && string.Equals("location", name, StringComparison.InvariantCultureIgnoreCase);
+        }
+
+        private string FormatParameterWithValue(string name, object value)
+        {
+            return $"-{name} {value}";
+        }
+
+        private string FormatParameterWithMaskedValue(string name, object value)
+        {
+            return $"-{name} ***";
+        }
+    }
+}

src/Accounts/Authentication/Utilities/Telemetry/ParameterTelemetryFormatter.cs

@@ -31,5 +31,6 @@ internal static class ConfigKeys
         public const string EnableTestCoverage = "EnableTestCoverage";
         public const string EnableLoginByWam = "EnableLoginByWam";
         public const string TestCoverageLocation = "TestCoverageLocation";
+        public const string DisplayRegionIdentified = "DisplayRegionIdentified";
     }
 }