Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- 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: 10/30/2025 ms.custom: devx-track-bicep --- # Create Bicep files with Visual Studio Code This article shows you how to use Visual Studio Code to create Bicep files. ## Install Visual Studio Code To set up your environment for Bicep development, see [Install Bicep tools](install.md). After completing those steps, you have [Visual Studio Code](https://code.visualstudio.com/) and the [Bicep extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep) installed. You also have either the latest [Azure CLI](/cli/azure/) or the latest [Azure PowerShell module](/powershell/azure/new-azureps-module-az). ## Bicep commands Visual Studio Code comes with several Bicep commands. Open or create a Bicep file in Visual Studio Code, and select the **View** menu and then **Command Palette**. You can also press **F1** or the **<kbd>Ctrl+Shift+P</kbd>** key combination to bring up the command palette. Enter **Bicep** to list the Bicep commands. :::image type="content" source="./media/visual-studio-code/visual-studio-code-bicep-commands.png" alt-text="Screenshot of Visual Studio Code Bicep commands in the command palette."::: These commands include: - [Build Azure Resource Manager (ARM) template](#build-arm-template-command) - [Build Parameters File](#build-parameters-file-command) - [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) - [Import Azure Kubernetes Manifest (EXPERIMENTAL)](#import-aks-manifest-preview-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) These commands are also shown in the context menu when you right-click a Bicep file: :::image type="content" source="./media/visual-studio-code/visual-studio-code-bicep-context-menu.png" alt-text="Screenshot of Visual Studio Code Bicep commands in the context menu for Bicep files."::: And when you right-click a JSON file: :::image type="content" source="./media/visual-studio-code/visual-studio-code-bicep-context-menu-json.png" alt-text="Screenshot of Visual Studio Code Bicep commands in the context menu for JSON ARM templates."::: To learn more about the commands in this article, see [Bicep CLI commands](./bicep-cli.md). In addition to the Bicep commands, you can also use the built-in VS Code commands, such as `Format Documents`, or <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>F</kbd>. ### Build ARM Template command The `build` command converts a Bicep file to a JSON ARM template. The new template is stored in the same folder with the same file name. If a file with the same file name exists, it overwrites the old file. See [build](./bicep-cli.md#build) for an example and more information. ### Build Parameters File command The `build-params` command also converts a [Bicep parameters file](./parameter-files.md#parameters-file) to a [JSON parameters file](../templates/parameter-files.md#parameter-file). The new parameters file is stored in the same folder with the same file name. If a file with the same file name exists, it overwrites the old file. See [build-params](./bicep-cli.md#build-params) for an example. ### Create Bicep Configuration File command The [_bicepconfig.json_ file](./bicep-config.md) is a Bicep configuration file that can customize your Bicep development experience. You can add _bicepconfig.json_ to multiple directories; the configuration file closest to the Bicep file in the directory hierarchy is used. When you select **Create Bicep Configuration File** in Visual Studio Code, the extension opens a dialog for you to select a folder. The default folder is where you store the Bicep file. If a _bicepconfig.json_ file already exists in the folder, you can overwrite the existing file. To create a Bicep configuration file: 1. Open Visual Studio Code. 1. From the **View** menu, select **Command Palette** (or press **<kbd>Ctrl/Cmd+Shift+P</kbd>**) and then **Bicep: Create Bicep Configuration File**. 1. Select the file directory where you want to place the file. 1. Save the configuration file when you're done. ### Decompile into Bicep command The `decompile` command decompiles a JSON ARM template into a Bicep file and places it in the same directory as the original JSON ARM template. The new file has the same file name with the `.bicep` extension. If a Bicep file with the same file name already exists in the same folder, Visual Studio Code prompts you to overwrite the existing file or create a copy. See [decompile](./bicep-cli.md#decompile) for an example. ### Deploy Bicep File command You can deploy Bicep files directly from Visual Studio Code. Select **Deploy Bicep File** from the command palette or from the context menu. The extension prompts you to sign into the Azure portal, select your subscription, create or select a resource group, and enter values for parameters. [!INCLUDE [Visual Studio Code authentication](../../../includes/resource-manager-vscode-authentication.md)] ### Generate Parameters File command The `generate-params` command creates a parameters file in the same folder as the Bicep file. You can choose to create a Bicep parameters file or a JSON parameters file. The new Bicep parameters file name is `<bicep-file-name>.bicepparam`, while the new JSON parameters file name is `<bicep-file-name>.parameters.json`. See [generate-params](./bicep-cli.md#generate-params) for an example and more information. ### Import AKS Manifest (Preview) command This command imports an [AKS manifest file](/azure/aks/concepts-clusters-workloads#deployments-and-yaml-manifests) and creates a [Bicep module](./modules.md). For more information, see [Bicep Kubernetes extension (preview)](./bicep-kubernetes-extension.md) and [Quickstart: Deploy an Azure Kubernetes Service (AKS) cluster using the Bicep Kubernetes extension (preview)](/azure/aks/learn/quick-kubernetes-deploy-bicep-kubernetes-extension). ### Insert Resource command This command declares a resource in the Bicep file by providing the resource ID of an existing resource. Select **Insert Resource** in Visual Studio Code, and enter the resource ID in the command palette. It takes a few moments to insert the resource. You can use one of these methods to find the resource ID: - Use the [Azure Resources extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureresourcegroups). :::image type="content" source="./media/visual-studio-code/visual-studio-code-azure-resources-extension.png" alt-text="Screenshot of the Azure Resources extension for Visual Studio Code."::: - Check the [Azure portal](https://portal.azure.com). - Use the Azure CLI or Azure PowerShell: # [Azure CLI](#tab/azure-cli) ```azurecli az resource list ``` # [Azure PowerShell](#tab/azure-powershell) ```azurepowershell Get-AzResource ``` --- Similar to the process of exporting templates, this process tries to create a usable resource. However, most of the inserted resources need to be changed in some way before they can be used to deploy Azure resources. For more information, see [Decompile ARM template JSON to Bicep](./decompile.md). ### Open Bicep Visualizer command Bicep Visualizer shows the resources defined in the Bicep file and the dependencies between them. Following diagram is a visual representation of a [Bicep file for a Linux Virtual Machine](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.compute/vm-simple-linux/main.bicep). [](./media/visual-studio-code/visual-studio-code-bicep-visualizer-expanded.png#lightbox) You can open Bicep Visualizer side by side with the Bicep file. ### Paste JSON as Bicep command You can paste a JSON snippet from an ARM template to a Bicep file. Visual Studio Code automatically decompiles the JSON to Bicep. This feature is only available with the Bicep extension version 0.14.0 or newer, and it's enabled by default. To disable the feature, see [Visual Studio Code and Bicep extension](./install.md#visual-studio-code-and-bicep-extension). This feature allows you to paste: - Full JSON ARM templates. - Single or multiple resources. - JSON values such as objects, arrays, or strings. A string with double quotation marks converts to one with single quotation marks. For example, you can start with the following Bicep file: ```bicep @description('Storage Account type') @allowed([ 'Standard_LRS' 'Standard_GRS' 'Standard_ZRS' 'Premium_LRS' ]) param storageAccountsku string = 'Standard_LRS' @description('Location for all resources.') param location string = resourceGroup().location var storageAccountName = '${uniqueString(resourceGroup().id)}storage' resource storageAccount 'Microsoft.Storage/storageAccounts@2025-06-01' = { name: storageAccountName location: location sku: { name: storageAccountsku } kind: 'StorageV2' tags: { ObjectName: storageAccountName } properties: {} } output storageAccountName string = storageAccountName ``` And paste the following JSON: ```json { "type": "Microsoft.Batch/batchAccounts", "apiVersion": "2024-02-01", "name": "[parameters('batchAccountName')]", "location": "[parameters('location')]", "tags": { "ObjectName": "[parameters('batchAccountName')]" }, "properties": { "autoStorage": { "storageAccountId": "[resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName'))]" } } } ``` Visual Studio Code automatically converts JSON to Bicep. Notice that you also need to add a `batchAccountName` parameter. You can undo the decompilation by pressing **<kbd>Ctrl+Z</kbd>**. The original JSON appears in the file. ### 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. For more information and an example, see [restore](./bicep-cli.md#restore). ### Show Deployment Pane command See [Deployment pane](#deployment-pane). ## Use quick fix suggestions The light bulb in VS Code represents a quick fix suggestion. It appears when the editor detects an issue or an improvement opportunity in your code. Clicking on the light bulb displays a menu of actions that can address the issue or enhance the code. :::image type="content" source="./media/visual-studio-code/visual-studio-code-bicep-context-quick-fix-suggestions.png" alt-text="Screenshot of Visual Studio Code quick fix suggestions."::: For the extract commands, see [Extract parameters, variables, and types](#extract-parameters-variables-and-types). In **More Actions**, it suggests adding [decorators](./variables.md#use-decorators). ## Extract parameters, variables, and types Extracting [variables](./variables.md), [parameters](./parameters.md), and [user-defined data types](./user-defined-data-types.md) involves isolating and defining these components from existing code to improve code structure, maintainability, and clarity. The following screenshot shows a definition of an AKS cluster resource. You can extract a parameter or a variable, or a user-defined data type based of a property, such as `identity`. Select the `identity` line from the code, and then select the yellow light bulb icon. The context windows shows the available extract options. :::image type="content" source="./media/visual-studio-code/visual-studio-code-azure-variable-parameter-type-extraction.png" alt-text="Screenshot of variable, parameter, type extraction."::: - **Extract variable**: Create a new variable, plus the option to update the variable name: :::image type="content" source="./media/visual-studio-code/visual-studio-code-azure-variable-parameter-type-extract-variable.png" alt-text="Screenshot of extracting variable."::: - **Extract parameter of a simple data type**: Create a new parameter with a simple data type such as string, int, etc., plus the option to update the parameter name: :::image type="content" source="./media/visual-studio-code/visual-studio-code-azure-variable-parameter-type-extract-parameter.png" alt-text="Screenshot of extracting parameter."::: - **Extract parameter of a user-defined data type**: Create a new parameter with a user-defined data type, plus the option to update the parameter name: :::image type="content" source="./media/visual-studio-code/visual-studio-code-azure-variable-parameter-type-extract-parameter-with-allowed-values.png" alt-text="Screenshot of extracting parameter with allowed values."::: This requires some customization after the extraction. - **Create user-defined type**: Create a new user-defined type, plus the option to update the type name. :::image type="content" source="./media/visual-studio-code/visual-studio-code-azure-variable-parameter-type-extract-type.png" alt-text="Screenshot of extracting user-defined data types."::: Unlike the other options, it doesn't replace the selected code with a reference to the new type. In the preceding example, the value of `identity` remains as it is. To use the new type, you must incorporate it into your code. ## View Documentation option From Visual Studio Code, you can open the template reference for the resource type in which you're working. To do so, hover your cursor over a resource's symbolic name, and select **View Documentation**. :::image type="content" source="./media/visual-studio-code/visual-studio-code-bicep-view-type-document.png" alt-text="Screenshot of the View Documentation option in Visual Studio Code."::: ## Go to file 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="Screenshot 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="Screenshot 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="Screenshot 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: :::image type="content" source="./media/visual-studio-code/visual-studio-code-bicep-problems-pane.png" alt-text="Screenshot of the Problems pane in Visual Studio Code."::: [Bicep core diagnostics](./bicep-core-diagnostics.md) provides a list of error and warning codes. ## Next steps Continue to [Quickstart: Create Bicep files with Visual Studio Code](./quickstart-create-bicep-use-visual-studio-code.md) for a tutorial of how to apply the information in this article.