The dashboards resource type can be deployed to:
For a list of changed properties in each API version, see change log.
For more information about creating dashboards, see The structure of Azure dashboards.
To create a Microsoft.Portal/dashboards resource, add the following JSON to your template.
{
"type": "Microsoft.Portal/dashboards",
"apiVersion": "2020-09-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"lenses": [
{
"metadata": {},
"order": "int",
"parts": [
{
"metadata": {
"type": "string"
// For remaining properties, see DashboardPartMetadata objects
},
"position": {
"colSpan": "int",
"metadata": {},
"rowSpan": "int",
"x": "int",
"y": "int"
}
}
]
}
],
"metadata": {}
}
}
Set the type property to specify the type of object.
For Extension/HubsExtension/PartType/MarkdownPart, use:
"type": "Extension/HubsExtension/PartType/MarkdownPart",
"inputs": [ object ],
"settings": {
"content": {
"settings": {
"content": "string",
"markdownSource": "int",
"markdownUri": "string",
"subtitle": "string",
"title": "string"
}
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Portal/dashboards' |
apiVersion | The resource api version | '2020-09-01-preview' |
name | The resource name | string (required) Character limit: 3-160 Valid characters: Alphanumerics and hyphens. To use restricted characters, add a tag named hidden-title with the dashboard name you want to use. The portal displays that name when showing the dashboard. |
location | Resource location | string (required) |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
properties | The shared dashboard properties. | DashboardProperties |
Name | Description | Value |
---|---|---|
lenses | The dashboard lenses. | DashboardLens[] |
metadata | The dashboard metadata. | object |
Name | Description | Value |
---|---|---|
metadata | The dashboard len's metadata. | object |
order | The lens order. | int (required) |
parts | The dashboard parts. | DashboardParts[] (required) |
Name | Description | Value |
---|---|---|
metadata | The dashboard part's metadata. | DashboardPartMetadata |
position | The dashboard's part position. | DashboardPartsPosition (required) |
Name | Description | Value |
---|---|---|
type | Set the object type | Extension/HubsExtension/PartType/MarkdownPart (required) |
Name | Description | Value |
---|---|---|
type | The type of dashboard part. | 'Extension/HubsExtension/PartType/MarkdownPart' (required) |
inputs | Input to dashboard part. | any[] |
settings | Markdown part settings. | MarkdownPartMetadataSettings |
Name | Description | Value |
---|---|---|
content | The content of markdown part. | MarkdownPartMetadataSettingsContent |
Name | Description | Value |
---|---|---|
settings | The setting of the content of markdown part. | MarkdownPartMetadataSettingsContentSettings |
Name | Description | Value |
---|---|---|
content | The content of the markdown part. | string |
markdownSource | The source of the content of the markdown part. | int |
markdownUri | The uri of markdown content. | string |
subtitle | The subtitle of the markdown part. | string |
title | The title of the markdown part. | string |
Name | Description | Value |
---|---|---|
colSpan | The dashboard's part column span. | int (required) |
metadata | The dashboard part's metadata. | object |
rowSpan | The dashboard's part row span. | int (required) |
x | The dashboard's part x coordinate. | int (required) |
y | The dashboard's part y coordinate. | int (required) |
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Deploy a simple Azure Spring Apps microservice application |
This template deploys a simple Azure Spring Apps microservice application to run on Azure. |
Create an Azure ML monitoring dashboard |
This template creates an AML dashboard on top of existing Log Analytics workspaces diagnostics data |
Create an Azure portal dashboard |
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. |
Shared default dashboard |
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. |