Microsoft.Portal dashboards

Template format

To create a Microsoft.Portal/dashboards resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Portal/dashboards",
  "apiVersion": "2020-09-01-preview",
  "properties": {
    "lenses": [
      {
        "order": "integer",
        "parts": [
          {
            "position": {
              "x": "integer",
              "y": "integer",
              "rowSpan": "integer",
              "colSpan": "integer",
              "metadata": {}
            },
            "metadata": {
              "additionalProperties": {},
              "type": "string"
            }
          }
        ],
        "metadata": {}
      }
    ],
    "metadata": {}
  },
  "location": "string",
  "tags": {}
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Portal/dashboards object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The name of the dashboard.
type enum Yes For JSON - Microsoft.Portal/dashboards
apiVersion enum Yes For JSON - 2020-09-01-preview
properties object Yes The shared dashboard properties. - DashboardProperties object
location string Yes Resource location
tags object No Resource tags

DashboardProperties object

Name Type Required Value
lenses array No The dashboard lenses. - DashboardLens object
metadata object No The dashboard metadata.

DashboardLens object

Name Type Required Value
order integer Yes The lens order.
parts array Yes The dashboard parts. - DashboardParts object
metadata object No The dashboard len's metadata.

DashboardParts object

Name Type Required Value
position object Yes The dashboard's part position. - DashboardPartsPosition object
metadata object No The dashboard part's metadata. - DashboardPartMetadata object

DashboardPartsPosition object

Name Type Required Value
x integer Yes The dashboard's part x coordinate.
y integer Yes The dashboard's part y coordinate.
rowSpan integer Yes The dashboard's part row span.
colSpan integer Yes The dashboard's part column span.
metadata object No The dashboard part's metadata.

DashboardPartMetadata object

Name Type Required Value
additionalProperties object No Unmatched properties from the message are deserialized this collection
type string Yes

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Shared default dashboard

Deploy to Azure
In order to make an application operational it helps to have a shared dashboard view of the services that make up the system. This dashboard provides a quickstart for customizing and sharing that with others on the team.
Create an Azure portal dashboard

Deploy to Azure
This template creates an example dashboard in the Azure portal, showing performance of an existing virtual machine in your subscription, as well as some static information and links.