How to Deploy Using ARM Template in Azure

To deploy using an ARM template, you create a JSON file that defines your Azure resources and then run the az deployment group create command with your resource group and template file. This command reads the template and provisions the resources in Azure automatically.

Syntax

The basic syntax to deploy an ARM template uses the Azure CLI command:

• az deployment group create: Deploys resources to a resource group.
• --resource-group: Specifies the target resource group.
• --template-file: Path to your ARM template JSON file.
• --parameters: Optional, to pass parameters to the template.

bash

az deployment group create --resource-group <resource-group-name> --template-file <template-file-path> --parameters <parameters-file-or-values>

Example

This example deploys a simple storage account using an ARM template. It shows how to run the deployment command with a resource group and template file.

json/bash

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storageAccountName": {
      "type": "string",
      "metadata": {
        "description": "Name of the storage account"
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2022-09-01",
      "name": "[parameters('storageAccountName')]",
      "location": "eastus",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2",
      "properties": {}
    }
  ]
}

# Deployment command:
az deployment group create --resource-group MyResourceGroup --template-file storage-template.json --parameters storageAccountName=mystorageacct123

Output

Deployment succeeded. Storage account 'mystorageacct123' created in resource group 'MyResourceGroup'.

Common Pitfalls

Common mistakes when deploying ARM templates include:

• Using an invalid or missing resource-group name.
• Incorrect template JSON syntax or schema version.
• Not providing required parameters or using wrong parameter names.
• Trying to deploy resources to a region not supported by the resource type.
• Forgetting to login to Azure CLI with az login before deployment.

Always validate your template with az deployment group validate before deploying.

bash

az deployment group validate --resource-group MyResourceGroup --template-file storage-template.json --parameters storageAccountName=mystorageacct123

# Correct deployment command after validation:
az deployment group create --resource-group MyResourceGroup --template-file storage-template.json --parameters storageAccountName=mystorageacct123

Output

Validation succeeded.

Quick Reference

Remember these key points when deploying ARM templates:

• Always login with az login.
• Use az deployment group validate to check your template before deployment.
• Specify the correct resource group with --resource-group.
• Pass parameters correctly with --parameters.
• Check Azure region availability for your resources.

Key Takeaways

Use the Azure CLI command az deployment group create with your ARM template and resource group to deploy resources.

Validate your ARM template before deployment using az deployment group validate to catch errors early.

Always login to Azure CLI with az login before deploying templates.

Provide all required parameters correctly to avoid deployment failures.

Check resource availability in your chosen Azure region before deploying.