Bird
Raised Fist0
Azurecloud~5 mins

ARM template structure in Azure - Commands & Configuration

Choose your learning style10 modes available
LearnWhyDeepVisualTryChallengeProjectRecallTime

Start learning this pattern below

Jump into concepts and practice - no test required

or
Recommended
Test this pattern10 questions across easy, medium, and hard to know if this pattern is strong
Introduction
When you want to create or update resources in Azure, you need a clear plan. ARM templates help you describe what resources you want and how they connect, so Azure can build them automatically.
When you want to create a virtual machine and its network settings together in one step.
When you need to set up a storage account and a database at the same time.
When you want to repeat the same setup in different Azure regions without mistakes.
When you want to share your infrastructure setup with teammates or save it for later.
When you want to update or delete resources safely by changing the template.
Config File - azuredeploy.json
azuredeploy.json
{
  "$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"
      }
    }
  },
  "variables": {},
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2022-09-01",
      "name": "[parameters('storageAccountName')]",
      "location": "eastus",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2",
      "properties": {}
    }
  ],
  "outputs": {
    "storageAccountId": {
      "type": "string",
      "value": "[resourceId('Microsoft.Storage/storageAccounts', parameters('storageAccountName'))]"
    }
  }
}

$schema: Defines the template schema version for validation.

contentVersion: Version of your template for tracking changes.

parameters: Inputs you provide when deploying, like the storage account name.

variables: Values you can reuse inside the template (empty here).

resources: The Azure resources to create, here a storage account with its settings.

outputs: Values returned after deployment, like the resource ID of the storage account.

Commands
This command deploys the ARM template to the resource group named 'example-rg', creating the storage account with the name 'examplestorage123'.
Terminal
az deployment group create --resource-group example-rg --template-file azuredeploy.json --parameters storageAccountName=examplestorage123
Expected OutputExpected
{ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.Resources/deployments/deploymentName", "name": "deploymentName", "properties": { "provisioningState": "Succeeded", "outputs": { "storageAccountId": { "type": "String", "value": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/examplestorage123" } } }, "type": "Microsoft.Resources/deployments" }
→
--resource-group - Specifies the Azure resource group where resources will be deployed.
→
--template-file - Points to the ARM template file to use for deployment.
→
--parameters - Provides values for the parameters defined in the template.
This command checks the details of the storage account created to confirm it exists and see its properties.
Terminal
az storage account show --name examplestorage123 --resource-group example-rg
Expected OutputExpected
{ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/examplestorage123", "location": "eastus", "name": "examplestorage123", "sku": { "name": "Standard_LRS", "tier": "Standard" }, "kind": "StorageV2", "properties": { "provisioningState": "Succeeded" }, "resourceGroup": "example-rg", "type": "Microsoft.Storage/storageAccounts" }
→
--name - Specifies the name of the storage account to show.
→
--resource-group - Specifies the resource group where the storage account exists.
Key Concept

If you remember nothing else from this pattern, remember: ARM templates describe your Azure resources in a clear, repeatable way so Azure can build them automatically.

Common Mistakes
Using a storage account name that is too short or contains invalid characters.
Azure requires storage account names to be between 3 and 24 characters and use only lowercase letters and numbers.
Choose a name that meets Azure's naming rules, like 'examplestorage123'.
Forgetting to specify the resource group in the deployment command.
Without the resource group, Azure doesn't know where to create the resources and the command fails.
Always include the --resource-group flag with the correct group name.
Editing the template file with syntax errors like missing commas or braces.
JSON syntax errors prevent the template from deploying and cause confusing error messages.
Use a JSON validator or editor that highlights syntax errors before deploying.
Summary
ARM templates use JSON to describe Azure resources and their settings.
You deploy templates with the Azure CLI using 'az deployment group create' and provide parameters.
After deployment, you verify resources exist with commands like 'az storage account show'.

Practice

(1/5)
1. Which section in an ARM template is used to define the Azure resources you want to create?
easy
A. outputs
B. parameters
C. resources
D. variables

Solution

  1. Step 1: Understand ARM template sections

    An ARM template has sections like parameters, variables, resources, and outputs.

  2. Step 2: Identify the section for Azure resources

    The 'resources' section lists the Azure services and components to create.

  3. Final Answer:

    resources -> Option C

  4. Quick Check:

    Resources section defines Azure resources [OK]
Hint: Resources section always holds Azure resource definitions [OK]
Common Mistakes:
  • Confusing parameters with resources
  • Thinking variables define resources
  • Mixing outputs with resource definitions
2. Which of the following is the correct way to start an ARM template JSON file?
easy
A. { "parameters": { }, "variables": { }, "resources": [ ] }
B. [ "parameters", "variables", "resources" ]
C.
D. parameters: {}, variables: {}, resources: []

Solution

  1. Step 1: Recognize ARM template format

    ARM templates are JSON files with keys like parameters, variables, and resources.

  2. Step 2: Check JSON syntax correctness

    { "parameters": { }, "variables": { }, "resources": [ ] } uses valid JSON object syntax with keys and empty objects/arrays.

  3. Final Answer:

    { "parameters": { }, "variables": { }, "resources": [ ] } -> Option A

  4. Quick Check:

    ARM templates start with JSON objects [OK]
Hint: ARM templates are JSON objects with keys, not arrays or XML [OK]
Common Mistakes:
  • Using array brackets instead of object braces
  • Writing XML tags instead of JSON
  • Omitting quotes around keys
3. Given this ARM template snippet:
{ "parameters": { "vmName": { "type": "string" } }, "variables": { "location": "eastus" }, "resources": [ { "type": "Microsoft.Compute/virtualMachines", "name": "[parameters('vmName')]", "location": "[variables('location')]" } ] }

What will be the location of the virtual machine if the parameter vmName is set to "MyVM"?
medium
A. MyVM
B. westus
C. undefined
D. eastus

Solution

  1. Step 1: Identify location value in variables

    The variable 'location' is set to "eastus" in the variables section.

  2. Step 2: Understand resource location assignment

    The VM's location uses the variable 'location', so it will be "eastus" regardless of vmName.

  3. Final Answer:

    eastus -> Option D

  4. Quick Check:

    Location comes from variables, not parameters [OK]
Hint: Resource location uses variables, not parameters [OK]
Common Mistakes:
  • Confusing vmName parameter with location
  • Assuming location is from parameters
  • Ignoring variable usage syntax
4. Identify the error in this ARM template snippet:
{ "parameters": { "storageName": { "type": "string" } }, "resources": [ { "type": "Microsoft.Storage/storageAccounts", "name": "storageName", "location": "eastus" } ] }
medium
A. The location value must be a variable, not a string
B. The resource name should use parameter syntax with brackets
C. Parameters section cannot be empty
D. Resource type is invalid

Solution

  1. Step 1: Check resource name usage

    The resource name is set as "storageName" string, but it should reference the parameter.

  2. Step 2: Correct parameter reference syntax

    Parameters are referenced with "[parameters('storageName')]" to use the parameter value.

  3. Final Answer:

    The resource name should use parameter syntax with brackets -> Option B

  4. Quick Check:

    Parameter references need brackets and function call [OK]
Hint: Use [parameters('name')] to reference parameters in resources [OK]
Common Mistakes:
  • Using parameter name as plain string
  • Thinking location must be variable
  • Assuming resource type is wrong
5. You want to output the public IP address of a VM created in your ARM template. Which section should you add this output to, and what is the correct syntax to reference the IP address property named "ipAddress" from a resource named "myPublicIP"?
hard
A. Add to outputs section with "ip": { "value": "[reference('myPublicIP').ipAddress]" }
B. Add to variables section with "ip": "myPublicIP.ipAddress"
C. Add to parameters section with "ipAddress": { "type": "string" }
D. Add to resources section with "outputs": { "ip": "myPublicIP.ipAddress" }

Solution

  1. Step 1: Identify output section usage

    Outputs section is used to return values after deployment, like IP addresses.

  2. Step 2: Use correct syntax to reference resource property

    Use the reference() function with resource name and property: "[reference('myPublicIP').ipAddress]".

  3. Final Answer:

    Add to outputs section with "ip": { "value": "[reference('myPublicIP').ipAddress]" } -> Option A

  4. Quick Check:

    Outputs use reference() to get resource properties [OK]
Hint: Use outputs section and reference() function for resource properties [OK]
Common Mistakes:
  • Putting outputs in variables or parameters
  • Using dot notation without reference()
  • Misplacing outputs inside resources