Microsoft.Portal dashboards 2018-10-01-preview

• Latest
• 2020-09-01-preview
• 2019-01-01-preview
• 2018-10-01-preview
• 2015-08-01-preview

Bicep resource definition

The dashboards resource type can be deployed to:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Remarks

For more information about creating dashboards, see The structure of Azure dashboards.

Resource format

To create a Microsoft.Portal/dashboards resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Portal/dashboards@2018-10-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    lenses: {}
    metadata: {}
  }
}

Property values

dashboards

Name	Description	Value
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

DashboardProperties

Name	Description	Value
lenses	The dashboard lenses.	object
metadata	The dashboard metadata.	object

Quickstart templates

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.

ARM template resource definition

The dashboards resource type can be deployed to:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Remarks

For more information about creating dashboards, see The structure of Azure dashboards.

Resource format

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",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "lenses": {},
    "metadata": {}
  }
}

Property values

dashboards

Name	Description	Value
type	The resource type	'Microsoft.Portal/dashboards'
apiVersion	The resource api version	'2018-10-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

DashboardProperties

Name	Description	Value
lenses	The dashboard lenses.	object
metadata	The dashboard metadata.	object

Quickstart templates

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.

Terraform (AzAPI provider) resource definition

The dashboards resource type can be deployed to:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      lenses = {}
      metadata = {}
    }
  })
}

Property values

dashboards

Name	Description	Value
type	The resource type	"Microsoft.Portal/dashboards@2018-10-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)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags	Dictionary of tag names and values.
properties	The shared dashboard properties.	DashboardProperties

DashboardProperties

Name	Description	Value
lenses	The dashboard lenses.	object
metadata	The dashboard metadata.	object