Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- title: 'Quickstart: Integrate Bicep with Azure Pipelines' description: This quickstart explains how to use Bicep and `.bicepparam` files to configure continuous integration and continuous deployments in Azure Pipelines by using the Bicep Deploy task, the Azure Resource Manager template deployment task, or an Azure CLI task. author: torreymicrosoft ms.author: torreyt ms.topic: quickstart ms.custom: devx-track-bicep, devx-track-azurecli ms.date: 06/11/2026 --- # Quickstart: Integrate Bicep with Azure Pipelines This quickstart shows you how to integrate Bicep files with Azure Pipelines for continuous integration and continuous deployment. It provides a short introduction to the pipeline task you need for deploying a Bicep file. ## Prerequisites If you don't have an Azure subscription, [create a free account](https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn) before you begin. You also need an Azure DevOps organization. If you don't have one, [create one for free](/azure/devops/pipelines/get-started/pipelines-sign-up). If your team already has an Azure DevOps organization, make sure you're an administrator of the Azure DevOps project that you want to use. You need to have configured a [service connection](/azure/devops/pipelines/library/connect-to-azure) to your Azure subscription. The tasks in the pipeline execute under the identity of the service principal. For steps to create the connection, see [Create a DevOps project](../templates/deployment-tutorial-pipeline.md#create-a-devops-project). You need a [Bicep file](./quickstart-create-bicep-use-visual-studio-code.md) that defines the infrastructure for your project. This file is in a repository. You need a ['.bicepparam' file](/azure/azure-resource-manager/bicep/parameter-files) that defines the parameters that your Bicep file uses. This file is in a repository. ## Create pipeline 1. From your Azure DevOps organization, select **Pipelines** and **Create pipeline**. :::image type="content" source="./media/add-template-to-azure-pipelines/new-pipeline.png" alt-text="Screenshot of creating new pipeline."::: 1. Specify where your code is stored. This quickstart uses Azure Repos Git repos. :::image type="content" source="./media/add-template-to-azure-pipelines/select-source.png" alt-text="Screenshot of selecting code source."::: 1. Select the repository that has the code for your project. :::image type="content" source="./media/add-template-to-azure-pipelines/select-repo.png" alt-text="Screenshot of selecting repository."::: 1. Select **Starter pipeline** for the type of pipeline to create. :::image type="content" source="./media/add-template-to-azure-pipelines/select-pipeline.png" alt-text="Screenshot of selecting pipeline."::: ## Deploy Bicep files You can deploy a Bicep file by using the Bicep Deploy task, the Azure Resource Manager template deployment task, or an Azure CLI task. The Bicep Deploy task is the recommended option for new pipelines. ### Use Bicep Deploy task The [Bicep Deploy task](/azure/devops/pipelines/tasks/reference/bicep-deploy-v0) (`BicepDeploy@0`) is a first-party task that's purpose-built for Bicep. It deploys `.bicep` and `.bicepparam` files directly without precompiling them to JSON ARM templates, and it automatically downloads and caches the Bicep CLI. The task supports: - **Standard deployments** at resource group, subscription, management group, and tenant scopes. - **[Deployment stacks](./deployment-stacks.md)**, including deny settings and actions on unmanaged resources, so you can manage a collection of resources as a single unit. - **[What-if operations](./deploy-what-if.md)** to preview changes before you apply them. - **Validation** of Bicep templates before deployment. - **Output masking** for sensitive outputs such as secrets and connection strings. The task runs on an [Azure Pipelines agent](/azure/devops/pipelines/agents/agents) — the computing infrastructure with installed agent software that runs your pipeline jobs — and requires agent software version 2.144.0 or later. [Microsoft-hosted agents](/azure/devops/pipelines/agents/hosted) are kept up to date automatically and always meet this requirement. If you run the task on a [self-hosted agent](/azure/devops/pipelines/agents/agents#install), make sure the agent is on version 2.144.0 or later. #### Deploy a Bicep file 1. Replace your starter pipeline with the following YAML. It uses the Bicep Deploy task to deploy a Bicep and `.bicepparam` file to an existing resource group. ```yml trigger: - main name: Deploy Bicep files parameters: - name: azureServiceConnection type: string default: '<your-connection-name>' variables: vmImageName: 'ubuntu-latest' subscriptionId: '<your-subscription-id>' resourceGroupName: 'exampleRG' templateFile: './main.bicep' parametersFile: './main.bicepparam' pool: vmImage: $(vmImageName) steps: - task: BicepDeploy@0 inputs: azureResourceManagerConnection: '${{ parameters.azureServiceConnection }}' type: 'deployment' operation: 'create' scope: 'resourceGroup' subscriptionId: '$(subscriptionId)' resourceGroupName: '$(resourceGroupName)' name: 'DeployPipelineTemplate' templateFile: '$(templateFile)' parametersFile: '$(parametersFile)' ``` 1. Update the values of `azureServiceConnection`, `subscriptionId`, and `resourceGroupName`. 1. Verify you have a valid `main.bicep` file in your repo. 1. Verify you have a valid `main.bicepparam` file in your repo that contains a [`using`](/azure/azure-resource-manager/bicep/bicep-using) statement. 1. Verify the target resource group already exists. The Bicep Deploy task deploys resources into an existing resource group at the `resourceGroup` scope; it doesn't create the resource group for you. 1. Select **Save**. The build pipeline runs automatically. Go back to the summary for your build pipeline, and watch the status. For the full list of task inputs, see the [Bicep Deploy task reference](/azure/devops/pipelines/tasks/reference/bicep-deploy-v0). #### Deploy a deployment stack To manage your resources as a [deployment stack](./deployment-stacks.md) instead of a standard deployment, set `type` to `deploymentStack` and provide the deployment stack inputs. The following step creates or updates a deployment stack, deletes resources that are removed from the template, and blocks out-of-band writes and deletes to managed resources: ```yml steps: - task: BicepDeploy@0 inputs: azureResourceManagerConnection: '${{ parameters.azureServiceConnection }}' type: 'deploymentStack' operation: 'create' name: 'production-stack' scope: 'resourceGroup' subscriptionId: '$(subscriptionId)' resourceGroupName: '$(resourceGroupName)' templateFile: '$(templateFile)' parametersFile: '$(parametersFile)' actionOnUnmanageResources: 'delete' denySettingsMode: 'denyWriteAndDelete' ``` To preview the changes a deployment stack makes before you apply them, set `operation` to `whatIf`. For more information about the what-if operation, see [Preview changes with what-if](./deploy-what-if.md). ### Use Azure Resource Manager template deployment task > [!NOTE] > As of [Azure Resource Manager template deployment task](/azure/devops/pipelines/tasks/reference/azure-resource-manager-template-deployment-v3) version 3.235.0, usage of ['.bicepparam'](/azure/azure-resource-manager/bicep/parameter-files) files is supported. > [!NOTE] > The `AzureResourceManagerTemplateDeployment@3` task requires both Bicep and `.bicepparam` files to be provided when using `.bicepparam`. The Bicep file can reference all supported locations for module references. The `.bicepparam` file must reference the local Bicep file in the `using` statement. 1. Replace your starter pipeline with the following YAML. It uses the Azure Resource Manager template deployment task to create a resource group and deploy a Bicep and `.bicepparam` file. ```yml trigger: - main name: Deploy Bicep files parameters: - name: azureServiceConnection type: string default: '<your-connection-name>' variables: vmImageName: 'ubuntu-latest' resourceGroupName: 'exampleRG' location: '<your-resource-group-location>' templateFile: './main.bicep' csmParametersFile: './main.bicepparam' pool: vmImage: $(vmImageName) steps: - task: AzureResourceManagerTemplateDeployment@3 inputs: deploymentScope: 'Resource Group' action: 'Create Or Update Resource Group' resourceGroupName: '$(resourceGroupName)' location: '$(location)' templateLocation: 'Linked artifact' csmFile: '$(templateFile)' csmParametersFile: '$(csmParametersFile)' overrideParameters: '-storageAccountType Standard_LRS' deploymentMode: 'Incremental' deploymentName: 'DeployPipelineTemplate' connectedServiceName: '${{ parameters.azureServiceConnection }}' ``` 1. Update the values of `azureServiceConnection` and `location`. 1. Verify you have a valid `main.bicep` file in your repo. 1. Verify you have a valid `main.bicepparam` file in your repo that contains a [`using`](/azure/azure-resource-manager/bicep/bicep-using) statement. 1. Select **Save**. The build pipeline runs automatically. Go back to the summary for your build pipeline, and watch the status. ### Use Azure CLI task > [!NOTE] > The [`az deployment group create`](/cli/azure/deployment/group?view=azure-cli-latest#az-deployment-group-create&preserve-view=true) command requires only a `bicepparam.` file. The `using` statement in the `.bicepparam` file can target any supported location to reference the Bicep file. A Bicep file is only required in your repository when `using` from a local disk path with the Azure CLI. > [!NOTE] > When you use a [`.bicepparam`](/azure/azure-resource-manager/bicep/parameter-files) file with the [`az deployment group create`](/cli/azure/deployment/group?view=azure-cli-latest#az-deployment-group-create&preserve-view=true) command, you can't override parameters. 1. Replace your starter pipeline with the following YAML. It creates a resource group and deploys a [`.bicepparam`](/azure/azure-resource-manager/bicep/parameter-files) file by using an [Azure CLI task](/azure/devops/pipelines/tasks/reference/azure-cli-v2): ```yml trigger: - main name: Deploy Bicep files parameters: azureServiceConnection: '<your-connection-name>' variables: vmImageName: 'ubuntu-latest' resourceGroupName: 'exampleRG' location: '<your-resource-group-location>' bicepParamFile: './main.bicepparam' pool: vmImage: $(vmImageName) steps: - task: AzureCLI@2 inputs: azureSubscription: '${{ parameters.azureServiceConnection }}' scriptType: bash scriptLocation: inlineScript useGlobalConfig: false inlineScript: | az --version az group create --name $(resourceGroupName) --location $(location) az deployment group create ` --resource-group $(resourceGroupName) ` --parameters $(bicepParamFile) ` --name DeployPipelineTemplate ``` For the descriptions of the task inputs, see [Azure CLI v2 task](/azure/devops/pipelines/tasks/reference/azure-cli-v2). When using the task on air-gapped cloud, you must set the `useGlobalConfig` property of the task to `true`. The default value is `false`. 1. Update the values of `azureServiceConnection` and `location`. 1. Verify you have a valid `main.bicepparam` file in your repo that contains a [`using`](/azure/azure-resource-manager/bicep/bicep-using) statement. 1. Select **Save**. The build pipeline runs automatically. Go back to the summary for your build pipeline, and watch the status. ## Clean up resources When the Azure resources are no longer needed, use the Azure CLI or Azure PowerShell to delete the quickstart resource group. # [Azure CLI](#tab/azure-cli) ```azurecli az group delete --name exampleRG ``` # [Azure PowerShell](#tab/azure-powershell) ```azurepowershell Remove-AzResourceGroup -Name exampleRG ``` --- ## Next steps > [!div class="nextstepaction"] > [Deploy Bicep files by using GitHub Actions](deploy-github-actions.md)