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), as well as 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

  • If you don't have an Azure subscription, create a free account before you begin.
  • An existing VM.

Create 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.

    Select Cloud shell from the Azure portal ribbon

  2. In the Cloud Shell window, select PowerShell.

    Select PowerShell in the terminal window

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

    New-AzResourceGroup -Name SimpleWinVmResourceGroup -Location EastUS
    

    Copy a command into the command prompt

  4. Copy the following command and enter it at the command prompt to create a VM in the resource group.

    New-AzVm `
        -ResourceGroupName "SimpleWinVmResourceGroup" `
        -Name "SimpleWinVm" `
        -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.

    The VM deployment now starts and typically takes a few minutes to complete. After deployment completes, 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. One Azure resource is defined in the template, Microsoft.Portal/dashboards - Create a dashboard in the Azure portal.

Deploy the template

  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.

    ARM template, create dashboard, deploy portal

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

    • Subscription: select an Azure subscription.
    • Resource group: select SimpleWinVmResourceGroup.
    • Location: select East US.
    • Virtual Machine Name: enter SimpleWinVm.
    • Virtual Machine Resource Group: enter SimpleWinVmResourceGroup.
  3. Select Create or Purchase. After the dashboard has been deployed successfully, you get a notification:

    ARM template, create dashboard, deploy portal notification

The Azure portal was used to deploy the template. In addition to the Azure portal, you can also use Azure PowerShell, Azure CLI, and REST API. To learn other deployment methods, see Deploy templates.

Review deployed resources

Verify that you can see data about the virtual machine from within the Azure portal dashboard.

  1. In the Azure portal, select Dashboard.

    Azure portal navigation to dashboard

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

    Navigate to Simple VM Dashboard

  3. Review the dashboard that the Azure Resource Manager template (ARM template) created. You can see that some of the content is static, but there are also charts that show the performance of the VM you created at the beginning.

    Review Simple VM Dashboard

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.

    Delete resource group

Next steps

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