Support supplemental parameters when used with .bicepparam parameter file (#22904)

* Add support for supplemental parameters

* Add changelog entry

* Use precise minimal version #

* Update ChangeLog.md

---------

Co-authored-by: Yabo Hu <[email protected]>

Author: anthony-c-martin

src/Resources/ResourceManager/Implementation/CmdletBase/DeploymentCmdletBase.cs

@@ -195,6 +195,21 @@ protected override void OnBeginProcessing()
             base.OnBeginProcessing();
         }
 
+        private string GetParameterJsonFilePath()
+        {
+            if (BicepUtility.IsBicepparamFile(TemplateParameterFile))
+            {
+                return null;
+            }
+            
+            if (!string.IsNullOrEmpty(TemplateParameterUri))
+            {
+                return TemplateParameterUri;
+            }
+
+            return this.ResolvePath(TemplateParameterFile);
+        }
+
         public new virtual object GetDynamicParameters()
         {
             if (BicepUtility.IsBicepFile(TemplateUri))
@@ -233,47 +248,26 @@ protected override void OnBeginProcessing()
                 // Resolve the static parameter names for this cmdlet:
                 string[] staticParameterNames = this.GetStaticParameterNames();
                 var combinedParameterObject = GetCombinedTemplateParameterObject();
+                var jsonParamFilePath = BicepUtility.IsBicepparamFile(TemplateParameterFile) ? null : this.ResolvePath(TemplateParameterFile);
 
                 if (TemplateObject != null && TemplateObject != templateObject)
                 {
                     templateObject = TemplateObject;
-                    if (string.IsNullOrEmpty(TemplateParameterUri))
-                    {
-                        dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
-                            TemplateObject,
-                            combinedParameterObject,
-                            this.ResolvePath(TemplateParameterFile),
-                            staticParameterNames);
-                    }
-                    else
-                    {
-                        dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
-                            TemplateObject,
-                            combinedParameterObject,
-                            TemplateParameterUri,
-                            staticParameterNames);
-                    }
+                    dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
+                        TemplateObject,
+                        combinedParameterObject,
+                        GetParameterJsonFilePath(),
+                        staticParameterNames);
                 }
                 else if (!string.IsNullOrEmpty(TemplateFile) &&
                     !TemplateFile.Equals(templateFile, StringComparison.OrdinalIgnoreCase))
                 {
                     templateFile = TemplateFile;
-                    if (string.IsNullOrEmpty(TemplateParameterUri))
-                    {
-                        dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
-                            this.ResolvePath(TemplateFile),
-                            combinedParameterObject,
-                            this.ResolvePath(TemplateParameterFile),
-                            staticParameterNames);
-                    }
-                    else
-                    {
-                        dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
-                            this.ResolvePath(TemplateFile),
-                            combinedParameterObject,
-                            TemplateParameterUri,
-                            staticParameterNames);
-                    }
+                    dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
+                        this.ResolvePath(TemplateFile),
+                        combinedParameterObject,
+                        GetParameterJsonFilePath(),
+                        staticParameterNames);
                 }
                 else if (!string.IsNullOrEmpty(TemplateUri) &&
                     !TemplateUri.Equals(templateUri, StringComparison.OrdinalIgnoreCase))
@@ -286,22 +280,12 @@ protected override void OnBeginProcessing()
                     {
                         templateUri = protectedTemplateUri;
                     }
-                    if (string.IsNullOrEmpty(TemplateParameterUri))
-                    {
-                        dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
-                            templateUri,
-                            combinedParameterObject,
-                            this.ResolvePath(TemplateParameterFile),
-                            staticParameterNames);
-                    }
-                    else
-                    {
-                        dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
-                            templateUri,
-                            combinedParameterObject,
-                            TemplateParameterUri,
-                            staticParameterNames);
-                    }
+
+                    dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
+                        templateUri,
+                        combinedParameterObject,
+                        GetParameterJsonFilePath(),
+                        staticParameterNames);
                 }
                 else if (!string.IsNullOrEmpty(TemplateSpecId) &&
                     !TemplateSpecId.Equals(templateSpecId, StringComparison.OrdinalIgnoreCase))
@@ -346,22 +330,11 @@ protected override void OnBeginProcessing()
                         throw;
                     }
 
-                    if (string.IsNullOrEmpty(TemplateParameterUri))
-                    {
-                        dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
-                            templateObj,
-                            combinedParameterObject,
-                            this.ResolvePath(TemplateParameterFile),
-                            staticParameterNames);
-                    }
-                    else
-                    {
-                        dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
-                            templateObj,
-                            combinedParameterObject,
-                            TemplateParameterUri,
-                            staticParameterNames);
-                    }
+                    dynamicParameters = TemplateUtility.GetTemplateParametersFromFile(
+                        templateObj,
+                        combinedParameterObject,
+                        GetParameterJsonFilePath(),
+                        staticParameterNames);
                 }
             }
 
@@ -393,9 +366,12 @@ protected Hashtable GetTemplateParameterObject()
             var parameterObject = new Hashtable();
             if (bicepparamFileParameters != null)
             {
+                BuildAndUseBicepParameters();
                 AddToParametersHashtable(bicepparamFileParameters, parameterObject);
+                return parameterObject;
             }
-            else if (TemplateParameterObject != null)
+
+            if (TemplateParameterObject != null)
             {
                 foreach (var parameterKey in TemplateParameterObject.Keys)
                 {
@@ -428,12 +404,11 @@ protected Hashtable GetTemplateParameterObject()
                     WriteWarning("${templateParameterFilePath} does not exist");
                 }
             }
-            
-            // Load dynamic parameters
-            IEnumerable<RuntimeDefinedParameter> parameters = PowerShellUtilities.GetUsedDynamicParameters(this.AsJobDynamicParameters, MyInvocation);
-            if (parameters.Any())
+
+            var dynamicParams = GetDynamicParametersDictionary();
+            foreach (var param in dynamicParams)
             {
-                parameters.ForEach(dp => parameterObject[((ParameterAttribute)dp.Attributes[0]).HelpMessage] = new Hashtable { { "value", dp.Value } });
+                parameterObject[param.Key] = new Hashtable { { "value", param.Value } };
             }
 
             return parameterObject;
@@ -503,12 +478,18 @@ protected void BuildAndUseBicepTemplate()
             TemplateFile = BicepUtility.BuildFile(this.ResolvePath(TemplateFile), this.WriteVerbose, this.WriteWarning);
         }
 
-        protected void BuildAndUseBicepParameters()
+        private IReadOnlyDictionary<string, object> GetDynamicParametersDictionary()
         {
-            var output = BicepUtility.BuildParams(this.ResolvePath(TemplateParameterFile), this.WriteVerbose, this.WriteWarning);
+            var dynamicParams = PowerShellUtilities.GetUsedDynamicParameters(this.AsJobDynamicParameters, MyInvocation);
+
+            return dynamicParams.ToDictionary(
+                x => ((ParameterAttribute)x.Attributes[0]).HelpMessage,
+                x => x.Value);
+        }
 
-            TemplateParameterFile = null;
-            TemplateParameterObject = null;
+        protected void BuildAndUseBicepParameters()
+        {
+            var output = BicepUtility.BuildParams(this.ResolvePath(TemplateParameterFile), GetDynamicParametersDictionary(), this.WriteVerbose, this.WriteWarning);
             bicepparamFileParameters = GetParametersFromJson(output.parametersJson);
 
             if (TemplateObject == null && 

src/Resources/ResourceManager/Implementation/CmdletBase/DeploymentStacksCmdletBase.cs

@@ -17,6 +17,7 @@
 using Microsoft.Azure.Commands.ResourceManager.Cmdlets.Utilities;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System.Collections;
+using System.Collections.Generic;
 using System.IO;
 using System.Text;
 
@@ -70,7 +71,7 @@ protected BicepBuildParamsStdout ResolveBicepParameterFile(string TemplateParame
         {
             if (BicepUtility.IsBicepparamFile(TemplateParameterFile))
             {
-                return BicepUtility.BuildParams(this.ResolvePath(TemplateParameterFile), this.WriteVerbose, this.WriteWarning);
+                return BicepUtility.BuildParams(this.ResolvePath(TemplateParameterFile), new Dictionary<string, object>(), this.WriteVerbose, this.WriteWarning);
             }
 
             return null;