Microsoft.Portal dashboards 2018-10-01-preview
Article 11/25/2024
2 contributors
Feedback
In this article
For more information about creating dashboards, see The structure of Azure dashboards .
Bicep resource definition
The dashboards resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Portal/dashboards resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Portal/dashboards@2018-10-01-preview' = {
location: 'string'
name: 'string'
properties: {
lenses: {
{customized property}: {
metadata: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
order: int
parts: {
{customized property}: {
metadata: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
position: {
colSpan: int
metadata: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
rowSpan: int
x: int
y: int
}
}
}
}
}
metadata: {
{customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
tags: {
{customized property}: 'string'
}
}
Property values
DashboardLens
DashboardLensParts
DashboardParts
DashboardPartsPosition
Name
Description
Value
colSpan
The dashboard's part column span.
int (required)
metadata
The dashboard part's metadata.
DashboardPartsPositionMetadata
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)
DashboardProperties
DashboardPropertiesLenses
Microsoft.Portal/dashboards
Name
Description
Value
location
Resource location
string (required)
name
The resource name
string
properties
The shared dashboard properties.
DashboardProperties
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
Quickstart samples
The following quickstart samples deploy this resource type.
ARM template resource definition
The dashboards resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Portal/dashboards resource, add the following JSON to your template.
{
"type": "Microsoft.Portal/dashboards",
"apiVersion": "2018-10-01-preview",
"name": "string",
"location": "string",
"properties": {
"lenses": {
"{customized property}": {
"metadata": {
"{customized property}": {}
},
"order": "int",
"parts": {
"{customized property}": {
"metadata": {
"{customized property}": {}
},
"position": {
"colSpan": "int",
"metadata": {
"{customized property}": {}
},
"rowSpan": "int",
"x": "int",
"y": "int"
}
}
}
}
},
"metadata": {
"{customized property}": {}
}
},
"tags": {
"{customized property}": "string"
}
}
Property values
DashboardLens
DashboardLensParts
DashboardParts
DashboardPartsPosition
Name
Description
Value
colSpan
The dashboard's part column span.
int (required)
metadata
The dashboard part's metadata.
DashboardPartsPositionMetadata
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)
DashboardProperties
DashboardPropertiesLenses
Microsoft.Portal/dashboards
Name
Description
Value
apiVersion
The api version
'2018-10-01-preview'
location
Resource location
string (required)
name
The resource name
string
properties
The shared dashboard properties.
DashboardProperties
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
type
The resource type
'Microsoft.Portal/dashboards'
Quickstart templates
The following quickstart templates deploy this resource type.
Template
Description
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.
Deploy a simple Azure Spring Apps microservice application This template deploys a simple Azure Spring Apps microservice application to run on Azure.
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.
The dashboards resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Portal/dashboards resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Portal/dashboards@2018-10-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
lenses = {
{customized property} = {
metadata = {
{customized property} = ?
}
order = int
parts = {
{customized property} = {
metadata = {
{customized property} = ?
}
position = {
colSpan = int
metadata = {
{customized property} = ?
}
rowSpan = int
x = int
y = int
}
}
}
}
}
metadata = {
{customized property} = ?
}
}
})
}
Property values
DashboardLens
DashboardLensParts
DashboardParts
DashboardPartsPosition
Name
Description
Value
colSpan
The dashboard's part column span.
int (required)
metadata
The dashboard part's metadata.
DashboardPartsPositionMetadata
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)
DashboardProperties
DashboardPropertiesLenses
Microsoft.Portal/dashboards
Name
Description
Value
location
Resource location
string (required)
name
The resource name
string
properties
The shared dashboard properties.
DashboardProperties
tags
Resource tags
Dictionary of tag names and values.
type
The resource type
"Microsoft.Portal/dashboards@2018-10-01-preview"
