Quickstart: Create a dashboard in the Azure portal by using an ARM template

A dashboard in the Azure portal is a focused and organized view of your cloud resources. This quickstart focuses on the process of deploying an Azure Resource Manager template (ARM template) to create a dashboard. The dashboard shows the performance of a virtual machine (VM), and some static information and links.

An ARM template is a JavaScript Object Notation (JSON) file that defines the infrastructure and configuration for your project. The template uses declarative syntax. In declarative syntax, you describe your intended deployment without writing the sequence of programming commands to create the deployment.

If your environment meets the prerequisites and you're familiar with using ARM templates, select the Deploy to Azure button. The template will open in the Azure portal.

Deploy to Azure

Prerequisites

  • An Azure account with an active subscription. Create an account for free.

  • Azure PowerShell or Azure CLI.

  • A virtual machine. The dashboard you create in the next part of this quickstart requires an existing VM. Create a VM by following these steps.

    1. In the Azure portal, select Cloud Shell from the global controls at the top of the page.

      Screenshot showing the Cloud Shell option in the Azure portal.

    2. In the Cloud Shell window, select PowerShell.

      Screenshot showing the PowerShell option in Cloud Shell.

    3. Copy the following command and enter it at the command prompt to create a resource group.

      New-AzResourceGroup -Name SimpleWinVmResourceGroup -Location EastUS
      
    4. Next, copy the following command and enter it at the command prompt to create a VM in your new resource group.

      New-AzVm `
          -ResourceGroupName "SimpleWinVmResourceGroup" `
          -Name "myVM1" `
          -Location "East US"
      
    5. Enter a username and password for the VM. This is a new user name and password; it's not, for example, the account you use to sign in to Azure. For more information, see username requirements and password requirements.

    After the VM has been created, move on to the next section.

Review the template

The template used in this quickstart is from Azure Quickstart Templates. The template for this article is too long to show here. To view the template, see azuredeploy.json. The template defines one Azure resource, a dashboard that displays data about the VM you created.

Deploy the template

This example uses the Azure portal to deploy the template. You can also use other methods to deploy ARM templates, such as Azure PowerShell, Azure CLI, or REST API.

  1. Select the following image to sign in to Azure and open a template.

    Deploy to Azure

  2. Select or enter the following values, then select Review + create.

    Screenshot of the dashboard template deployment screen in the Azure portal.

    Unless it's specified, use the default values to create the dashboard.

    • Subscription: select the Azure subscription.
    • Resource group: select SimpleWinVmResourceGroup.
    • Location: If not automatically selected, choose East US.
    • Virtual Machine Name: enter myVM1.
    • Virtual Machine Resource Group: enter SimpleWinVmResourceGroup.
  3. Select Create. You'll see a notification confirming when the dashboard has been deployed successfully.

Review deployed resources

Verify that you can see data about your virtual machine in the Azure portal dashboard.

  1. In the Azure portal menu, select Dashboard.

    Screenshot of the Dashboard item on the Azure portal menu.

  2. On the dashboard page, select Simple VM Dashboard.

    Screenshot of the dashboard selection option in the Azure portal.

  3. Review the dashboard, which should look similar to the one shown here. While some of the content is static, there are also charts that show the performance of the VM you created at the beginning.

    Screenshot of an example dashboard in the Azure portal.

Clean up resources

If you want to remove the VM and associated dashboard, delete the resource group that contains them.

  1. In the Azure portal, search for SimpleWinVmResourceGroup, then select it in the search results.

  2. On the SimpleWinVmResourceGroup page, select Delete resource group, enter the resource group name to confirm, then select Delete.

Caution

Deleting a resource group will delete all of the resources contained within it. If the resource group contains additional resources aside from your virtual machine and dashboard, those resources will also be deleted.

Next steps

For more information about dashboards in the Azure portal, see: