Quickstart: Create an Azure portal dashboard with Azure CLI

A dashboard in the Azure portal is a focused and organized view of your cloud resources. This article shows you how to use Azure CLI to create a dashboard. In this example, the dashboard shows the performance of a virtual machine (VM), as well as some static information and links.

Prerequisites

  • If you have multiple Azure subscriptions, choose the appropriate subscription in which to bill the resources. Select a subscription by using the az account set command:

    az account set --subscription 00000000-0000-0000-0000-000000000000
    
  • Create an Azure resource group by using the az group create command (or use an existing resource group):

    az group create --name myResourceGroup --location centralus
    

Create a virtual machine

Create a virtual machine by using the az vm create command:

az vm create --resource-group myResourceGroup --name myVM1 --image win2016datacenter \
   --admin-username azureuser --admin-password 1StrongPassword$

Note

This is a new username and password (not the account you use to sign in to Azure). The password must be complex. For more information, see username requirements and password requirements.

The deployment starts and typically takes a few minutes to complete.

Download the dashboard template

Since Azure dashboards are resources, they can be represented as JSON. For more information, see The structure of Azure dashboards.

Download the file portal-dashboard-template-testvm.json.

Then, customize the downloaded template file by changing the following to your values:

  • <subscriptionID>: Your subscription
  • <rgName>: Resource group, for example myResourceGroup
  • <vmName>: Virtual machine name, for example myVM1
  • <dashboardTitle>: Dashboard title, for example Simple VM Dashboard
  • <location>: Your Azure region, for example centralus

For more information, see Microsoft portal dashboards template reference.

Deploy the dashboard template

You can now deploy the template from within Azure CLI.

  1. Run the az portal dashboard create command to deploy the template:

    az portal dashboard create --resource-group myResourceGroup --name 'Simple VM Dashboard' \
       --input-path portal-dashboard-template-testvm.json --location centralus
    
  2. Check that the dashboard was created successfully by running the az portal dashboard show command:

    az portal dashboard show --resource-group myResourceGroup --name 'Simple VM Dashboard'
    

To see all the dashboards for the current subscription, use az portal dashboard list:

az portal dashboard list

You can also see all the dashboards for a specific resource group:

az portal dashboard list --resource-group myResourceGroup

To update a dashboard, use the az portal dashboard update command:

az portal dashboard update --resource-group myResourceGroup --name 'Simple VM Dashboard' \
   --input-path portal-dashboard-template-testvm.json --location centralus

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

To remove the virtual machine and associated dashboard that you created, delete the resource group that contains them.

Caution

Deleting the 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.

az group delete --name myResourceGroup

To remove only the dashboard, use the az portal dashboard delete command:

az portal dashboard delete --resource-group myResourceGroup --name "Simple VM Dashboard"

Next steps

For more information about Azure CLI commands for dashboards, see: