Merge pull request #296608 from mumian/0312-deployment-pane

Cover VS Code deployment pane

Author: JillGrant615

articles/azure-resource-manager/bicep/deploy-vscode.md

@@ -2,19 +2,21 @@
 title: Deploy Bicep files with Visual Studio Code
 description: Learn how to use Visual Studio Code to deploy Bicep files.
 ms.topic: how-to
-ms.date: 01/10/2025
+ms.date: 03/19/2025
 ms.custom: devx-track-bicep
 ---
 
 # Deploy Bicep files with Visual Studio Code
 
-You can use [Visual Studio Code with the Bicep extension](./visual-studio-code.md#deploy-bicep-file-command) to deploy a Bicep file. You can deploy to any scope. This article shows how to deploy to a resource group.
+You can use [Visual Studio Code with the Bicep extension](./visual-studio-code.md#deploy-bicep-file-command) to deploy a Bicep file. Additionally, Bicep files can also be deployed from deployment pane. For more information, see [Deployment pane](./visual-studio-code.md#deployment-pane).
+
+You can deploy to any scope. This article shows how to deploy to a resource group.
 
 There are three ways you can find the command from an open Bicep file in Visual Studio Code:
 
 - Right-click the Bicep file name from the Explorer pane instead of the one under **OPEN EDITORS**:
 
-    :::image type="content" source="./media/deploy-vscode/bicep-deploy-from-explorer.png" alt-text="Screenshot of Deploying Bicep File in the Context menu from the explore pane.":::
+    :::image type="content" source="./media/deploy-vscode/bicep-deploy-from-explorer.png" alt-text="Screenshot of Deploying Bicep File in the Context menu from the explorer pane.":::
 
 - Right-click anywhere inside a Bicep file, and then select **Deploy Bicep File**.
 

articles/azure-resource-manager/bicep/deploy-what-if.md

@@ -10,7 +10,7 @@ ms.date: 09/26/2024
 
 Before deploying a Bicep file, you can preview the changes that will happen. Azure Resource Manager provides the what-if operation to let you see how resources will change if you deploy the Bicep file. The what-if operation doesn't make any changes to existing resources. Instead, it predicts the changes if the specified Bicep file is deployed.
 
-You can use the what-if operation with Azure PowerShell, Azure CLI, or REST API operations. What-if is supported for resource group, subscription, management group, and tenant level deployments.
+You can use the what-if operation with [Visual Studio Code](./visual-studio-code.md#deployment-pane), Azure PowerShell, Azure CLI, or REST API operations. What-if is supported for resource group, subscription, management group, and tenant level deployments.
 
 During What-If operations, the evaluation and expansion of `templateLink` aren't supported. As a result, any resources deployed using template links within nested deployments, including template spec references, won't be visible in the What-If operation results.
 

articles/azure-resource-manager/bicep/media/visual-studio-code/visual-studio-code-deployment-pane.png

@@ -2,7 +2,7 @@
 title: Create Bicep files with Visual Studio Code
 description: Learn how to use Visual Studio Code to create Bicep files.
 ms.topic: how-to
-ms.date: 01/10/2025
+ms.date: 03/21/2025
 ms.custom: devx-track-bicep
 ---
 
@@ -29,15 +29,15 @@ These commands include:
 - [Create Bicep Configuration File](#create-bicep-configuration-file-command)
 - [Decompile into Bicep](#decompile-into-bicep-command)
 - [Deploy Bicep File](#deploy-bicep-file-command)
-- [Generate Parameters File](#generate-parameters-file-command) 
+- [Generate Parameters File](#generate-parameters-file-command)
 - [Import Azure Kubernetes Manifest (EXPERIMENTAL)](#import-aks-manifest-preview-command)
-- [Insert Resource](#insert-resource-command) 
+- [Insert Resource](#insert-resource-command)
 - [Open Bicep Visualizer](#open-bicep-visualizer-command)
 - [Open Bicep Visualizer to the Side](#open-bicep-visualizer-command)
-- [Paste JSON as Bicep](#paste-json-as-bicep-command) 
-- [Restore Bicep Modules (Force)](#restore-bicep-modules-command) 
-- [Show Deployment Pane](#show-deployment-pane-command) 
-- [Show Deployment Pane to the Side](#show-deployment-pane-command) 
+- [Paste JSON as Bicep](#paste-json-as-bicep-command)
+- [Restore Bicep Modules (Force)](#restore-bicep-modules-command)
+- [Show Deployment Pane](#show-deployment-pane-command)
+- [Show Deployment Pane to the Side](#show-deployment-pane-command)
 
 These commands are also shown in the context menu when you right-click a Bicep file:
 
@@ -191,13 +191,11 @@ You can undo the decompilation by pressing **<kbd>Ctrl+Z</kbd>**. The original J
 
 ### Restore Bicep Modules command
 
-When your Bicep file uses modules that are published to a registry, the `restore` command gets copies of all the required modules from the registry. It stores those copies in a local cache. See [restore](./bicep-cli.md#restore) for more information and an example.
+When your Bicep file uses modules that are published to a registry, the `restore` command gets copies of all the required modules from the registry. It stores those copies in a local cache. For more information and an example, see [restore](./bicep-cli.md#restore).
 
 ### Show Deployment Pane command
 
-The Deployment Pane is an experimental feature in Visual Studio Code. See [Using the Deployment Pane (Experimental!)](https://github.com/Azure/bicep/blob/main/docs/experimental/deploy-ui.md) to learn more.
-
-You can open the Deployment Pane side by side with the Bicep file.
+See [Deployment pane](#deployment-pane).
 
 ## Use quick fix suggestions
 
@@ -245,6 +243,74 @@ From Visual Studio Code, you can open the template reference for the resource ty
 
 When defining a [module](./modules.md) and regardless of the type of file that's being referenced - a local file, module registry file, or a template spec - you can open the file by selecting or highlighting the module path and pressing **[F12]**. If the referenced file is an [Azure Verified Module, an AVM](https://aka.ms/avm), then you can toggle between the compiled JSON or Bicep file. To open the Bicep file of a private registry module, ensure that the module is published to the registry with the `WithSource` switch enabled. For more information, see [Publish files to registry](./private-module-registry.md#publish-files-to-registry). Visual Studio Code Bicep extension version 0.27.1 or newer is required for opening Bicep files from a private module registry.
 
+## Deployment pane
+
+The Deployment Pane is a UI panel that lets you connect to your Azure subscription and perform validate, deploy, and what-if operations, providing instant feedback without leaving the editor.
+
+To use deployment pane:
+
+1. Open a `.bicep` or `.bicepparam` file in VS Code.
+1. There are two ways to open the deployment pane:
+
+    - Select the show deployment pane button on the upper right corner as shown in the following screenshot:  
+
+        :::image type="content" source="./media/visual-studio-code/visual-studio-code-open-deployment-pane.png" alt-text="Sceenshot of the open deployment pane button.":::
+  
+        By default, VS Code opens the deployment pane on the side. To open it in a new tab, hold <kbd>Alt</kbd> while selecting the button.
+  
+    - Another way to open the deployment pane is through the command palette. Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>, then select either **Show Deployment Pane** or **Show Deployment Pane to the Side**.
+  
+        :::image type="content" source="./media/visual-studio-code/visual-studio-code-show-deployment-pane.png" alt-text="Sceenshot of show deployment pane in command palette.":::
+  
+    The following screenshot shows a successful deployment with the Bicep file validation results.
+  
+    :::image type="content" source="./media/visual-studio-code/visual-studio-code-deployment-pane.png" alt-text="Sceenshot of deployment pane in Visual Studio Code.":::
+  
+1. Select **Change Scope** to define the deployment scope. After authentication, you're able to select the subscription and the resource group of your desired deployment.
+1. Select **Pick JSON Parameters File** to select a JSON parameter file.  
+1. Select your desired action - **Deploy**, **Validate**, or **What-if**.  
+
+    - **Deploy**: deploys to Azure, and the result including the defined output are shown in the deployment pane.
+    - **Validate**: performs a runtime validation of the Bicep file against Azure, ensuring that the resources, parameters, and policies are correct in the actual deployment environment. Unlike a [linter](./linter.md), which only checks for syntax errors, this validation interacts with Azure to detect potential deployment issues. It's equivalent to the validate command in Azure CLI and the Test command in Azure PowerShell. For example:
+  
+        # [Azure CLI](#tab/azure-cli)
+        
+        ```azurecli
+        az deployment group validate --resource-group <resource-group-name> --template-file <template-file-path>        
+        ```
+        
+        # [Azure PowerShell](#tab/azure-powershell)
+        
+        ```azurepowershell
+        Test-AzResourceGroupDeployment -ResourceGroupName <ResourceGroupName> -TemplateFile <TemplateFilePath>
+        ```
+        
+        ---
+      
+    - **What-if**: executes a **What-If** analysis directly from the deployment pane. The pane displays the results, showing any planned changes. This performs the same function as the what-if command in Azure PowerShell and Azure CLI. For example:
+
+        # [Azure CLI](#tab/azure-cli)
+        
+        ```azurecli
+        az deployment group what-if --resource-group <resource-group-name> --template-file <template-file-path>        
+        ```
+        
+        # [Azure PowerShell](#tab/azure-powershell)
+        
+        ```azurepowershell
+        New-AzResourceGroupDeployment -Whatif -ResourceGroupName <ResourceGroupName> -TemplateFile <TemplateFilePath>
+        ```
+        
+        ---
+  
+    For more information, see one of the following articles:
+  
+    - [Bicep deployment what-if operation](./deploy-what-if.md)
+    - [Deploy Bicep files with Visual Studio Code](./deploy-vscode.md)
+    - [Deploy Bicep files with Azure CLI](./deploy-cli.md)
+    - [Deploy Bicep files with Azure PowerShell](./deploy-powershell.md)
+    - [Deploy Bicep files with Azure cloud shell](./deploy-cloud-shell.md)
+
 ## Troubleshoot
 
 The `Problems` pane summarizes the errors and warning in your Bicep file: