ARM template structure in Azure - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is an ARM template in Azure?

An ARM template is a JSON file that defines the infrastructure and configuration for Azure resources. It helps automate deployment in a repeatable way.

beginner

Name the main sections of an ARM template.

The main sections are:
1. $schema - defines the template schema URL
2. contentVersion - version of the template
3. parameters - inputs for customization
4. variables - values used inside the template
5. resources - the Azure resources to deploy
6. outputs - values returned after deployment

beginner

What is the purpose of the 'parameters' section in an ARM template?

The 'parameters' section lets you define inputs that users can provide when deploying the template. This makes the template flexible and reusable.

beginner

Explain the 'resources' section in an ARM template.

The 'resources' section lists all Azure resources to create or update. Each resource has properties like type, name, location, and settings.

beginner

What does the 'outputs' section do in an ARM template?

The 'outputs' section defines values that the template returns after deployment. These can be resource IDs, connection strings, or other useful info.

Which section of an ARM template defines the Azure resources to deploy?

A outputs

B parameters

C variables

D resources

The 'resources' section lists all Azure resources to create or update.

What is the purpose of the 'parameters' section in an ARM template?

A To define inputs for deployment customization

B To list Azure resources

C To return values after deployment

D To store fixed values used internally

'parameters' allow users to provide inputs to customize the deployment.

Which section contains the template schema URL in an ARM template?

A $schema

B parameters

C contentVersion

D variables

The '$schema' section defines the JSON schema URL for the ARM template.

What type of file format is used for ARM templates?

A YAML

B JSON

C XML

D INI

ARM templates are written in JSON format.

Which section would you use to return the resource ID after deployment?

A variables

B parameters

C outputs

D resources

The 'outputs' section defines values returned after deployment, such as resource IDs.

Describe the main sections of an ARM template and their roles.

Think about how the template is structured to define inputs, resources, and outputs.

Explain how the 'parameters' and 'outputs' sections help make ARM templates flexible and useful.

Consider how inputs and outputs improve automation.

Practice

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