Azure DevOps Pipelines with ARM templates

Deploying infrastructure as code (IaC) is a fundamental practice in modern DevOps, enabling teams to manage and provision infrastructure through code rather than manual processes. Azure Resource Manager (ARM) templates provide a declarative way to define and deploy Azure resources. When combined with Azure DevOps Pipelines, ARM templates facilitate continuous integration and continuous deployment (CI/CD) of infrastructure, ensuring consistent and repeatable deployments. This comprehensive guide will walk you through the process of integrating ARM templates with Azure DevOps Pipelines, covering each step in detail to help you achieve a robust and automated deployment pipeline.

1. Introduction to ARM Templates and Azure DevOps Pipelines

What are ARM Templates?

ARM templates are JSON files that define the infrastructure and configuration for your Azure resources. They enable you to deploy resources in a consistent and repeatable manner. An ARM template consists of several sections, including parameters, variables, resources, and outputs, allowing for flexible and modular deployments.

Benefits of Using ARM Templates with Azure DevOps Pipelines

• Automation: Automate the deployment of infrastructure, reducing manual errors and increasing efficiency.
• Consistency: Ensure consistent deployments across different environments.
• Version Control: Manage infrastructure code in source control, enabling tracking of changes and collaboration.
• Scalability: Easily scale deployments by modifying the template parameters.

2. Prerequisites

Before integrating ARM templates with Azure DevOps Pipelines, ensure you have the following:

• Azure Subscription: An active Azure subscription to deploy resources.
• Azure DevOps Account: Access to Azure DevOps Services.
• Git Repository: A repository to store your ARM templates and pipeline configuration.
• Service Connection: A service connection in Azure DevOps to authenticate and authorize the pipeline to deploy resources to Azure.

3. Creating and Structuring ARM Templates

Step 1: Define the ARM Template

1. Create the Template File:
   • Create a new JSON file named azuredeploy.json.
2. Define the Schema and Content Version:
   • Specify the $schema and contentVersion at the beginning of the template.
   { "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", "contentVersion": "1.0.0.0", // Additional sections }
3. Add Parameters:
   • Define parameters to make the template reusable and configurable.
   { "parameters": { "storageAccountName": { "type": "string", "minLength": 3, "maxLength": 24 } // Additional parameters } }
4. Define Resources:
   • Specify the resources to deploy, such as a Storage Account.
   { "resources": [ { "type": "Microsoft.Storage/storageAccounts", "apiVersion": "2021-04-01", "name": "[parameters('storageAccountName')]", "location": "[resourceGroup().location]", "sku": { "name": "Standard_LRS" }, "kind": "StorageV2", "properties": {} } ] }
5. Add Outputs (Optional):
   • Define outputs to return information after deployment.
   { "outputs": { "storageAccountEndpoint": { "type": "string", "value": "[reference(parameters('storageAccountName')).primaryEndpoints.blob]" } } }

Step 2: Parameterize the Template

1. Create a Parameters File:
   • Create a azuredeploy.parameters.json file to provide values for the parameters.
   { "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", "contentVersion": "1.0.0.0", "parameters": { "storageAccountName": { "value": "mystorageacct001" } // Additional parameter values } }
2. Secure Sensitive Data:
   • Avoid hardcoding sensitive information. Use Azure Key Vault or pipeline secrets to manage sensitive data securely.

4. Setting Up Azure DevOps Pipeline

Step 1: Create a New Pipeline

1. Navigate to Azure DevOps:
   • Log in to your Azure DevOps organization and select your project.
2. Create a New Pipeline:
   • Go to Pipelines > Create Pipeline.
   • Select the repository containing your ARM templates.
3. Choose Pipeline Configuration:
   • Select “Starter pipeline” or “Existing Azure Pipelines YAML file” if you have a predefined YAML file.

Step 2: Define the Pipeline YAML

1. Set Trigger:
   • Define the trigger to specify when the pipeline should run.
   trigger: branches: include: - main
2. Define Variables:
   • Set variables for reuse throughout the pipeline.
   variables: - name: resourceGroupName value: 'myResourceGroup' - name: location value: 'East US'
3. Add Stages:
   • Structure the pipeline into stages for organization and control.
   stages: - stage: Deploy jobs: - job: DeployInfrastructure steps: # Steps to deploy ARM template
4. Configure Steps:
   • Add tasks to the steps section to deploy the ARM template.
   steps: - task: AzureResourceManagerTemplateDeployment@3 inputs: deploymentScope: 'Resource Group' azureResourceManagerConnection: 'AzureServiceConnection' subscriptionId: 'your-subscription-id' action: 'Create Or Update Resource Group'