Merge pull request #307248 from mumian/1022-jsonrpc-format

add jsonrpc format

Author: Carolyn135

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

@@ -2,7 +2,7 @@
 title: Bicep CLI commands 
 description: Learn about the commands that you can use in the Bicep CLI. These commands include building JSON Azure Resource Manager templates from Bicep.
 ms.topic: reference
-ms.date: 09/09/2025
+ms.date: 10/22/2025
 ms.custom: devx-track-azurecli, devx-track-bicep, devx-track-arm-template
 ---
 
@@ -285,30 +285,67 @@ For example:
 Content-Length: 72\r\n\r\n{"jsonrpc": "2.0", "id": 0, "method": "bicep/version", "params": {}}\r\n\r\n
 ```
 
-The following message shows an example for Bicep version.
+The following methods are available through the JSON-RPC interface:
 
-* The input:
+* **bicep/format**
 
-  ```json
-  {
-    "jsonrpc": "2.0",
-    "id": 0,
-    "method": "bicep/version",
-    "params": {}
-  }
-  ```
+  Formats a Bicep file.
+  
+  * The request:
 
-* The output:
-
-  ```json
-  {
-    "jsonrpc": "2.0",
-    "id": 0,
-    "result": {
-      "version": "0.24.211"
+    ```json
+    {
+      "jsonrpc": "2.0",
+      "id": 1,
+      "method": "bicep/format",
+      "params": {
+        "path": "/path/to/file.bicep"
+      }
     }
-  }
-  ```
+    ```
+  
+  * The response:
+  
+    ```json
+    {
+      "jsonrpc": "2.0",
+      "id": 1,
+      "result": {
+        "success": true,
+        "diagnostics": [],
+        "contents": "param foo string\n\nresource storage 'Microsoft.Storage/storageAccounts@2025-01-01' = {\n  name: 'mystorageaccount'\n  location: 'East US'\n}\n"
+      }
+    }
+    ```
+
+    On success, `"success": true` is returned, with contents holding the formatted Bicep source. On failure, `"success": false` with `diagnostics` describing the failure.
+
+ * **bicep/version**
+
+  Returns the version of the Bicep CLI.
+  
+  * The request:
+  
+    ```json
+    {
+      "jsonrpc": "2.0",
+      "id": 0,
+      "method": "bicep/version",
+      "params": {}
+    }
+    ```
+
+  * The response:
+  
+    ```json
+    {
+      "jsonrpc": "2.0",
+      "id": 0,
+      "result": {
+        "version": "0.24.211"
+      }
+    }
+    ```
 
 For the available methods & request/response bodies, see [`ICliJsonRpcProtocol.cs`](https://github.com/Azure/bicep/blob/main/src/Bicep.Cli/Rpc/ICliJsonRpcProtocol.cs).
 For an example establishing a JSONRPC connection and interacting with Bicep files programmatically using Node, see [`jsonrpc.test.ts`](https://github.com/Azure/bicep/blob/main/src/Bicep.Cli.E2eTests/src/local/jsonrpc.test.ts).
@@ -331,7 +368,7 @@ N/A
 
 ---
 
-To connect to a named pipe on OSX/Linux :
+To connect to a named pipe on OSX/Linux:
 
 # [Bicep CLI](#tab/bicep-cli)
 
@@ -345,7 +382,7 @@ N/A
 
 ---
 
-To connect to a named pipe on Windows :
+To connect to a named pipe on Windows:
 
 # [Bicep CLI](#tab/bicep-cli)
 

articles/azure-resource-manager/bicep/toc.yml

@@ -621,7 +621,7 @@ items:
         href: /azure/templates/
       - name: Bicep CLI
         href: bicep-cli.md
-        displayName: build,decompile,install,list-versions,list versions,upgrade,version,module,registry
+        displayName: build,decompile,decompile-params, format,generate-params,install,jsonrpc,lint,list-versions,list versions,publish,restore,upgrade,version,module,registry
       - name: Azure CLI
         href: /cli/azure/resource
       - name: Azure PowerShell