Merge pull request #250738 from mumian/0908-az-bicepparam

add az bicepparam support

Author: prmerger-automator[bot]

articles/azure-resource-manager/bicep/bicep-cli.md

@@ -3,7 +3,7 @@ title: Bicep CLI commands and overview
 description: Describes the commands that you can use in the Bicep CLI. These commands include building Azure Resource Manager templates from Bicep.
 ms.topic: conceptual
 ms.custom: devx-track-azurecli, devx-track-bicep, devx-track-arm-template
-ms.date: 06/20/2023
+ms.date: 09/08/2023
 ---
 
 # Bicep CLI commands
@@ -12,9 +12,6 @@ This article describes the commands you can use in the Bicep CLI. You have two o
 
 This article shows how to run the commands in Azure CLI. When running through Azure CLI, you start the commands with `az`. If you're not using Azure CLI, run the commands without `az` at the start of the command. For example, `az bicep build` becomes `bicep build`, and `az bicep version` becomes `bicep --version`.
 
-> [!NOTE]
-> The commands related to the Bicep parameters files are exclusively supported within the Bicep CLI and are not currently available in Azure CLI. These commands include: `build-params`, `decompile-params`, and `generate-params`.
-
 ## build
 
 The `build` command converts a Bicep file to an Azure Resource Manager template (ARM template). Typically, you don't need to run this command because it runs automatically when you deploy a Bicep file. Run it manually when you want to see the ARM template JSON that is created from your Bicep file.
@@ -69,7 +66,7 @@ To use the `--no-restore` switch, you must have Bicep CLI version **0.4.1008 or
 The `build-params` command builds a _.bicepparam_ file into a JSON parameters file.
 
 ```azurecli
-bicep build-params params.bicepparam
+az bicep build-params --file params.bicepparam
 ```
 
 This command converts a _params.bicepparam_ parameters file into a _params.json_ JSON parameters file.
@@ -91,7 +88,7 @@ For more information about using this command, see [Decompiling ARM template JSO
 The `decompile-params` command decompile a JSON parameters file to a _.bicepparam_ parameters file.
 
 ```azurecli
-bicep decompile-params azuredeploy.parameters.json --bicep-file ./dir/main.bicep
+az bicep decompile-params -- file azuredeploy.parameters.json --bicep-file ./dir/main.bicep
 ```
 
 This command decompiles a _azuredeploy.parameters.json_ parameters file into a _azuredeploy.parameters.bicepparam_ file. `-bicep-file` specifies the path to the Bicep file (relative to the .bicepparam file) that is referenced in the `using` declaration.
@@ -101,13 +98,13 @@ This command decompiles a _azuredeploy.parameters.json_ parameters file into a _
 The `generate-params` command builds a parameters file from the given Bicep file, updates if there's an existing parameters file.
 
 ```azurecli
-bicep generate-params main.bicep --output-format bicepparam --include-params all
+az bicep generate-params --file main.bicep --output-format bicepparam --include-params all
 ```
 
 The command creates a Bicep parameters file named _main.bicepparam_. The parameter file contains all parameters in the Bicep file, whether configured with default values or not.
 
 ```azurecli
-bicep generate-params main.bicep --outfile main.parameters.json
+az bicep generate-params --file main.bicep --outfile main.parameters.json
 ```
 
 The command creates a parameter file named _main.parameters.json_. The parameter file only contains the parameters without default values configured in the Bicep file.
@@ -140,6 +137,8 @@ The command returns an array of available versions.
 
 ```azurecli
 [
+  "v0.20.4",
+  "v0.19.5",
   "v0.18.4",
   "v0.17.1",
   "v0.16.2",
@@ -167,9 +166,7 @@ The command returns an array of available versions.
   "v0.4.1124",
   "v0.4.1008",
   "v0.4.613",
-  "v0.4.451",
-  "v0.4.412",
-  "v0.4.63"
+  "v0.4.451"
 ]
 ```
 
@@ -264,7 +261,7 @@ az bicep version
 The command shows the version number.
 
 ```azurecli
-Bicep CLI version 0.4.1008 (223b8d227a)
+Bicep CLI version 0.20.4 (c9422e016d)
 ```
 
 To call this command directly through the Bicep CLI, use: