Add support for ARM params file and Bicep params file formats

dsc/examples/hello_world.dsc.bicep

@@ -2,11 +2,13 @@
 
 targetScope = 'desiredStateConfiguration'
 
+param text string = 'Hello, world!'
+
 // use workaround where Bicep currently requires version in date format
 resource echo 'Microsoft.DSC.Debug/Echo@2025-08-27' = {
   name: 'exampleEcho'
   properties: {
-    output: 'Hello, world!'
+    output: text
   }
 }
 

dsc/examples/hello_world.dsc.bicepparam

@@ -0,0 +1,3 @@
+using 'hello_world.dsc.bicep'
+
+param text = 'This is a parameterized hello world!'

dsc/examples/hello_world.dsc.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
+  "contentVersion": "1.0.0.0",
+  "parameters": {
+    "text": {
+      "value": "This is a parameterized hello world!"
+    }
+  }
+}

dsc/locales/en-us.toml

@@ -40,10 +40,7 @@ mcpAbout = "Use DSC as a MCP server"
 [main]
 ctrlCReceived = "Ctrl-C received"
 failedCtrlCHandler = "Failed to set Ctrl-C handler"
-failedReadingParametersFile = "Failed to read parameters file"
-readingParametersFromStdin = "Reading parameters from STDIN"
 generatingCompleter = "Generating completion script for"
-readingParametersFile = "Reading parameters from file"
 mergingParameters = "Merging inline parameters with parameters file (inline takes precedence)"
 failedMergingParameters = "Failed to merge parameters"
 usingDscVersion = "Running DSC version"

dsc/src/main.rs

@@ -4,14 +4,14 @@
 use args::{Args, SubCommand};
 use clap::{CommandFactory, Parser};
 use clap_complete::generate;
+use dsc_lib::progress::ProgressFormat;
 use mcp::start_mcp_server;
 use rust_i18n::{i18n, t};
-use std::{io, io::Read, process::exit};
+use std::{io, process::exit};
 use sysinfo::{Process, RefreshKind, System, get_current_pid, ProcessRefreshKind};
 use tracing::{error, info, warn, debug};
-use dsc_lib::progress::ProgressFormat;
 
-use crate::util::EXIT_INVALID_INPUT;
+use crate::util::{EXIT_INVALID_INPUT, get_input};
 
 #[cfg(debug_assertions)]
 use crossterm::event;
@@ -54,38 +54,11 @@ fn main() {
             generate(shell, &mut cmd, "dsc", &mut io::stdout());
         },
         SubCommand::Config { subcommand, parameters, parameters_file, system_root, as_group, as_assert, as_include } => {
-            // Read parameters from file if provided
-            let file_params = if let Some(file_name) = &parameters_file {
-                if file_name == "-" {
-                    info!("{}", t!("main.readingParametersFromStdin"));
-                    let mut stdin = Vec::<u8>::new();
-                    match io::stdin().read_to_end(&mut stdin) {
-                        Ok(_) => {
-                            match String::from_utf8(stdin) {
-                                Ok(input) => Some(input),
-                                Err(err) => {
-                                    error!("{}: {err}", t!("util.invalidUtf8"));
-                                    exit(EXIT_INVALID_INPUT);
-                                }
-                            }
-                        },
-                        Err(err) => {
-                            error!("{}: {err}", t!("util.failedToReadStdin"));
-                            exit(EXIT_INVALID_INPUT);
-                        }
-                    }
-                } else {
-                    info!("{}: {file_name}", t!("main.readingParametersFile"));
-                    match std::fs::read_to_string(file_name) {
-                        Ok(content) => Some(content),
-                        Err(err) => {
-                            error!("{} '{file_name}': {err}", t!("main.failedReadingParametersFile"));
-                            exit(util::EXIT_INVALID_INPUT);
-                        }
-                    }
-                }
-            } else {
+            let params = get_input(None, parameters_file.as_ref());
+            let file_params = if params.is_empty() {
                 None
+            } else {
+                Some(params)
             };
 
             let merged_parameters = match (file_params, parameters) {

dsc/tests/dsc_extension_discover.tests.ps1

@@ -24,29 +24,37 @@ Describe 'Discover extension tests' {
         $out = dsc extension list | ConvertFrom-Json
         $LASTEXITCODE | Should -Be 0
         if ($IsWindows) {
-            $out.Count | Should -Be 3 -Because ($out | Out-String)
+            $out.Count | Should -Be 4 -Because ($out | Out-String)
             $out[0].type | Should -Be 'Microsoft.DSC.Extension/Bicep'
             $out[0].version | Should -Be '0.1.0'
             $out[0].capabilities | Should -BeExactly @('import')
             $out[0].manifest | Should -Not -BeNullOrEmpty
-            $out[1].type | Should -Be 'Microsoft.Windows.Appx/Discover'
-            $out[1].version | Should -Be '0.1.0'
-            $out[1].capabilities | Should -BeExactly @('discover')
+            $out[1].type | Should -BeExactly 'Microsoft.DSC.Extension/BicepParameters'
+            $out[1].version | Should -BeExactly '0.1.0'
+            $out[1].capabilities | Should -BeExactly @('import')
             $out[1].manifest | Should -Not -BeNullOrEmpty
-            $out[2].type | Should -BeExactly 'Test/Discover'
-            $out[2].version | Should -BeExactly '0.1.0'
+            $out[2].type | Should -Be 'Microsoft.Windows.Appx/Discover'
+            $out[2].version | Should -Be '0.1.0'
             $out[2].capabilities | Should -BeExactly @('discover')
             $out[2].manifest | Should -Not -BeNullOrEmpty
+            $out[3].type | Should -BeExactly 'Test/Discover'
+            $out[3].version | Should -BeExactly '0.1.0'
+            $out[3].capabilities | Should -BeExactly @('discover')
+            $out[3].manifest | Should -Not -BeNullOrEmpty
         } else {
-            $out.Count | Should -Be 2 -Because ($out | Out-String)
+            $out.Count | Should -Be 3 -Because ($out | Out-String)
             $out[0].type | Should -Be 'Microsoft.DSC.Extension/Bicep'
             $out[0].version | Should -Be '0.1.0'
             $out[0].capabilities | Should -BeExactly @('import')
             $out[0].manifest | Should -Not -BeNullOrEmpty
-            $out[1].type | Should -BeExactly 'Test/Discover'
+            $out[1].type | Should -BeExactly 'Microsoft.DSC.Extension/BicepParameters'
             $out[1].version | Should -BeExactly '0.1.0'
-            $out[1].capabilities | Should -BeExactly @('discover')
+            $out[1].capabilities | Should -BeExactly @('import')
             $out[1].manifest | Should -Not -BeNullOrEmpty
+            $out[2].type | Should -BeExactly 'Test/Discover'
+            $out[2].version | Should -BeExactly '0.1.0'
+            $out[2].capabilities | Should -BeExactly @('discover')
+            $out[2].manifest | Should -Not -BeNullOrEmpty
         }
     }
 

dsc/tests/dsc_parameters.tests.ps1

@@ -394,6 +394,53 @@ Describe 'Parameters tests' {
       $errorMessage | Should -BeLike "*ERROR*Empty input provided*"
     }
 
+    It 'Parameters in ARM syntax are supported' {
+      $config_yaml = @"
+        `$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+        parameters:
+          myString:
+            type: string
+          myObject:
+            type: object
+          myArray:
+            type: array
+          myInt:
+            type: int
+          myBool:
+            type: bool
+        resources:
+        - name: echo
+          type: Microsoft.DSC.Debug/Echo
+          properties:
+            output: "[concat(parameters('myString'), '-', parameters('myObject').prop1, '-', parameters('myArray')[0], parameters('myArray')[1], '-', string(parameters('myInt')), '-', string(parameters('myBool'))]"
+"@
+      $params = @{
+        parameters = @{
+          myString = @{
+            value = 'Hello'
+          }
+          myObject = @{
+            value = @{
+              prop1 = 'World'
+            }
+          }
+          myArray = @{
+            value = @('Item1', 'Item2')
+          }
+          myInt = @{
+            value = 123
+          }
+          myBool = @{
+            value = $true
+          }
+        }
+      } | ConvertTo-Json -Compress -Depth 5
+
+      $out = $config_yaml | dsc -l trace config -p $params get -f - 2> $TestDrive/error.log | ConvertFrom-Json
+      $LASTEXITCODE | Should -Be 0 -Because (Get-Content -Path $TestDrive/error.log -Raw | Out-String)
+      $out.results[0].result.actualState.output | Should -BeExactly 'Hello-World-Item1Item2-123-true'
+    }
+
     It 'Invalid parameters read from STDIN result in error' {
       $params = @{
         osFamily = 'Windows'
@@ -403,7 +450,7 @@ Describe 'Parameters tests' {
       $LASTEXITCODE | Should -Be 4
       $out | Should -BeNullOrEmpty
       $errorMessage = Get-Content -Path $TestDrive/error.log -Raw
-      $errorMessage | Should -BeLike "*ERROR*Parameter input failure: JSON: missing field ````parameters````*"
+      $errorMessage | Should -BeLike "*ERROR*Invalid parameters format: missing field ````parameters````*"
     }
 
     It 'Parameters can reference other parameters in defaultValue: simple nested' {
@@ -935,7 +982,7 @@ parameters:
         }
         else {
             $expectedOutput = "{0}-{1}" -f $fileValue, $inlineValue
-        } 
+        }
         $out.results[0].result.actualState.output | Should -BeExactly $expectedOutput
     }
 

extensions/bicep/.project.data.json

@@ -3,7 +3,8 @@
     "Kind": "Extension",
     "CopyFiles": {
         "All": [
-            "bicep.dsc.extension.json"
+            "bicep.dsc.extension.json",
+            "bicepparams.dsc.extension.json"
         ]
     }
 }

extensions/bicep/bicep.tests.ps1

@@ -94,4 +94,12 @@ resource invalid 'Microsoft.DSC.Extension/Bicep:1.0' = {
         $content | Should -Match "Importing file '$bicepFile' with extension 'Microsoft.DSC.Extension/Bicep'"
         $content | Should -Match "BCP033"
     }
+
+    It 'Example bicep parameters file should work' {
+        $bicepFile = Resolve-Path -Path "$PSScriptRoot\..\..\dsc\examples\hello_world.dsc.bicep"
+        $bicepParamFile = Resolve-Path -Path "$PSScriptRoot\..\..\dsc\examples\hello_world.dsc.bicepparam"
+        $out = dsc -l trace config --parameters-file $bicepParamFile get --file $bicepFile 2>$TestDrive/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0 -Because (Get-Content -Path $TestDrive/error.log -Raw | Out-String)
+        $out.results[0].result.actualState.output | Should -BeExactly 'This is a parameterized hello world!'
+    }
 }

extensions/bicep/bicepparams.dsc.extension.json

@@ -0,0 +1,18 @@
+{
+    "$schema": "https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.json",
+    "type": "Microsoft.DSC.Extension/BicepParameters",
+    "version": "0.1.0",
+    "description": "Enable passing Bicep parameters file directly to DSC, but requires bicep executable to be available.",
+    "condition": "[not(equals(tryWhich('bicep'), null()))]",
+    "import": {
+        "fileExtensions": ["bicepparam"],
+        "executable": "bicep",
+        "args": [
+            "build-params",
+            {
+                "fileArg": ""
+            },
+            "--stdout"
+        ]
+    }
+}

lib/dsc-lib/locales/en-us.toml

@@ -85,6 +85,13 @@ secureOutputSkipped = "Secure output '%{name}' is skipped"
 outputTypeNotMatch = "Output '%{name}' type does not match expected type '%{expected_type}'"
 copyNotSupported = "Copy for output '%{name}' is currently not supported"
 
+[configure.parameters]
+importingParametersFromJson = "Importing parameters from `parameters_input` JSON"
+importingParametersFromComplexInput = "Importing parameters from complex input"
+importingParametersFromInput = "Importing parameters from simple input"
+invalidParamsJsonFormat = "Invalid parameters JSON format: %{error}"
+invalidParamsFormat = "Invalid parameters format: %{error}"
+
 [discovery.commandDiscovery]
 couldNotReadSetting = "Could not read 'resourcePath' setting"
 appendingEnvPath = "Appending PATH to resourcePath"

lib/dsc-lib/src/configure/mod.rs

@@ -2,7 +2,8 @@
 // Licensed under the MIT License.
 
 use crate::configure::context::{Context, ProcessMode};
-use crate::configure::{config_doc::{ExecutionKind, IntOrExpression, Metadata, Parameter, Resource, RestartRequired, ValueOrCopy}, parameters::Input};
+use crate::configure::parameters::import_parameters;
+use crate::configure::{config_doc::{ExecutionKind, IntOrExpression, Metadata, Parameter, Resource, RestartRequired, ValueOrCopy}};
 use crate::discovery::discovery_trait::DiscoveryFilter;
 use crate::dscerror::DscError;
 use crate::dscresources::{
@@ -836,7 +837,7 @@ impl Configurator {
         // process input parameters first
         if let Some(parameters_input) = parameters_input {
             trace!("parameters_input: {parameters_input}");
-            let input_parameters: HashMap<String, Value> = serde_json::from_value::<Input>(parameters_input.clone())?.parameters;
+            let input_parameters: HashMap<String, Value> = import_parameters(parameters_input)?;
 
             for (name, value) in input_parameters {
                 if let Some(constraint) = parameters.get(&name) {

lib/dsc-lib/src/configure/parameters.rs

@@ -1,16 +1,35 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+use crate::dscerror::DscError;
+use rust_i18n::t;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
 use std::{collections::HashMap, fmt::Display};
+use tracing::trace;
 
-#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[derive(Debug, Clone, PartialEq, Deserialize, JsonSchema)]
 pub struct Input {
     pub parameters: HashMap<String, Value>,
 }
 
+#[derive(Debug, Clone, PartialEq, Deserialize)]
+pub struct ComplexInput {
+    pub parameters: HashMap<String, InputObject>,
+}
+
+#[derive(Debug, Clone, PartialEq, Deserialize)]
+pub struct InputObject {
+    pub value: Value,
+}
+
+#[derive(Debug, Clone, PartialEq, Deserialize)]
+pub struct ParametersJson {
+    #[serde(rename = "parametersJson")]
+    pub parameters_json: String,
+}
+
 pub const SECURE_VALUE_REDACTED: &str = "<secureValue>";
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
@@ -64,3 +83,48 @@ pub enum SecureKind {
     #[serde(rename = "secureObject")]
     SecureObject(SecureObject),
 }
+
+pub fn import_parameters(parameters: &Value) -> Result<HashMap<String, Value>, DscError> {
+    let input = match serde_json::from_value::<ParametersJson>(parameters.clone()) {
+        Ok(input) => {
+            trace!("{}", t!("configure.parameters.importingParametersFromJson"));
+            let param_map = match serde_json::from_str::<ComplexInput>(&input.parameters_json) {
+                Ok(param_map) => param_map,
+                Err(e) => {
+                    return Err(DscError::Parser(t!("configure.parameters.invalidParamsJsonFormat", error = e).to_string()));
+                }
+            };
+            let mut result: HashMap<String, Value> = HashMap::new();
+            for (name, input_object) in param_map.parameters {
+                result.insert(name, input_object.value);
+            }
+            result
+        },
+        Err(_) => {
+            let complex_input = match serde_json::from_value::<ComplexInput>(parameters.clone()) {
+                Ok(complex_input) => {
+                    trace!("{}", t!("configure.parameters.importingParametersFromComplexInput"));
+                    let mut result: HashMap<String, Value> = HashMap::new();
+                    for (name, input_object) in complex_input.parameters {
+                        result.insert(name, input_object.value);
+                    }
+                    result
+                },
+                Err(_) => {
+                    let simple_input = match serde_json::from_value::<Input>(parameters.clone()) {
+                        Ok(simple_input) => {
+                            trace!("{}", t!("configure.parameters.importingParametersFromInput"));
+                            simple_input.parameters
+                        }
+                        Err(e) => {
+                            return Err(DscError::Parser(t!("configure.parameters.invalidParamsFormat", error = e).to_string()));
+                        }
+                    };
+                    simple_input
+                }
+            };
+            complex_input
+        },
+    };
+    Ok(input)
+}

lib/dsc-lib/src/extensions/dscextension.rs

@@ -43,6 +43,8 @@ pub enum Capability {
     Secret,
     /// The extension imports configuration from a different format.
     Import,
+    /// The extension imports parameters from a different format.
+    ImportParameters,
 }
 
 impl Display for Capability {
@@ -51,6 +53,7 @@ impl Display for Capability {
             Capability::Discover => write!(f, "Discover"),
             Capability::Secret => write!(f, "Secret"),
             Capability::Import => write!(f, "Import"),
+            Capability::ImportParameters => write!(f, "ImportParams"),
         }
     }
 }