Tutorial: Create ARM templates with dependent resources

Learn how to create an Azure Resource Manager template (ARM template) to deploy multiple resources and configure the deployment order. After you create the template, you deploy the template using Azure local Shell from your local computer.

In this tutorial, you create a storage account, a virtual machine, a virtual network, and some other dependent resources. Some of the resources cannot be deployed until another resource exists. For example, you can't create the virtual machine until its storage account and network interface exist. You define this relationship by making one resource as dependent on the other resources. Resource Manager evaluates the dependencies between resources, and deploys them in their dependent order. When resources aren't dependent on each other, Resource Manager deploys them in parallel. For more information, see Define the order for deploying resources in ARM templates.

Diagram that shows the deployment order of dependent resources in a Resource Manager template.

This tutorial covers the following tasks:

  • Open a Quickstart template
  • Explore the template
  • Deploy the template

If you don't have an Azure subscription, create a trial subscription before you begin.

Prerequisites

To complete this article, you need:

  • Visual Studio Code with Resource Manager Tools extension. See Quickstart: Create ARM templates with Visual Studio Code.

  • To increase security, use a generated password for the virtual machine administrator account. You can use Azure local Shell to run the following command in PowerShell or CLI:

    openssl rand -base64 32
    

    To learn more, run man openssl rand to open the manual page.

    Azure Key Vault is designed to safeguard cryptographic keys and other secrets. For more information, see Tutorial: Integrate Azure Key Vault in ARM template deployment. We also recommend you to update your password every three months.

Open a Quickstart template

Azure Quickstart Templates is a repository for ARM templates. Instead of creating a template from scratch, you can find a sample template and customize it. The template used in this tutorial is called Deploy a simple Windows VM.

  1. From Visual Studio Code, select File > Open File.

  2. In File name, paste the following URL:

    https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.compute/vm-simple-windows/azuredeploy.json
    
  3. Select Open to open the file.

  4. Select File > Save As to save a copy of the file to your local computer with the name azuredeploy.json.

Explore the template

When you explore the template in this section, try to answer these questions:

  • How many Azure resources defined in this template?
  • One of the resources is an Azure storage account. Does the definition look like the one used in the last tutorial?
  • Can you find the template references for the resources defined in this template?
  • Can you find the dependencies of the resources?
  1. From Visual Studio Code, collapse the elements until you only see the first-level elements and the second-level elements inside resources:

    Screenshot of Visual Studio Code displaying an ARM template with collapsed elements.

    There are six resources defined by the template:

    • Microsoft.Storage/storageAccounts.
    • Microsoft.Network/publicIPAddresses.
    • Microsoft.Network/networkSecurityGroups.
    • Microsoft.Network/virtualNetworks.
    • Microsoft.Network/networkInterfaces.
    • Microsoft.Compute/virtualMachines.

    It's helpful to review the template reference before customizing a template.

  2. Expand the first resource. It is a storage account.

    Screenshot of Visual Studio Code showing the storage account definition in an ARM template.

  3. Expand the second resource. The resource type is Microsoft.Network/publicIPAddresses.

    Screenshot of Visual Studio Code showing the public IP address definition in an ARM template.

  4. Expand the third resource. The resource type is Microsoft.Network/networkSecurityGroups.

    Screenshot of Visual Studio Code showing the network security group definition in an ARM template.

  5. Expand the fourth resource. The resource type is Microsoft.Network/virtualNetworks:

    Screenshot of Visual Studio Code showing the virtual network definition with dependsOn element in an ARM template.

    The dependsOn element enables you to define one resource as a dependent on one or more resources. This resource depends on one other resource:

    • Microsoft.Network/networkSecurityGroups
  6. Expand the fifth resource. The resource type is Microsoft.Network/networkInterfaces. The resource depends on two other resources:

    • Microsoft.Network/publicIPAddresses
    • Microsoft.Network/virtualNetworks
  7. Expand the sixth resource. This resource is a virtual machine. It depends on two other resources:

    • Microsoft.Storage/storageAccounts
    • Microsoft.Network/networkInterfaces

The following diagram illustrates the resources and the dependency information for this template:

Diagram that shows the dependency relationships between resources in an ARM template displayed in Visual Studio Code.

By specifying the dependencies, Resource Manager efficiently deploys the solution. It deploys the storage account, public IP address, and virtual network in parallel because they have no dependencies. After the public IP address and virtual network are deployed, the network interface is created. When all other resources are deployed, Resource Manager deploys the virtual machine.

Deploy the template

  1. Check and verify the template you saved earlier in the tutorial. The file name is azuredeploy.json.

  2. Run the following PowerShell script to deploy the template.

    echo "Enter a project name that is used to generate resource group name:" &&
    read projectName &&
    echo "Enter the location (i.e. chinaeast):" &&
    read location &&
    echo "Enter the virtual machine admin username:" &&
    read adminUsername &&
    echo "Enter the DNS label prefix:" &&
    read dnsLabelPrefix &&
    resourceGroupName="${projectName}rg" &&
    az group create --name $resourceGroupName --location $location &&
    az deployment group create --resource-group $resourceGroupName --template-file "$HOME/azuredeploy.json" --parameters adminUsername=$adminUsername dnsLabelPrefix=$dnsLabelPrefix
    
  3. RDP to the virtual machine to verify the virtual machine has been created successfully.

Clean up resources

When the Azure resources are no longer needed, clean up the resources you deployed by deleting the resource group.

  1. From the Azure portal, select Resource group from the left menu.
  2. Enter the resource group name in the Filter by name field.
  3. Select the resource group name. You'll see a total of six resources in the resource group.
  4. Select Delete resource group from the top menu.

Next steps

In this tutorial, you developed and deployed a template to create a virtual machine, a virtual network, and the dependent resources. To learn how to use deployment scripts to perform pre/post deployment operations, see: