Share via

Microsoft.Portal dashboards

  • Article

Remarks

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.

Resource format

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

resource symbolicname 'Microsoft.Portal/dashboards@2022-12-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    lenses: [
      {
        metadata: any(Azure.Bicep.Types.Concrete.AnyType)
        order: int
        parts: [
          {
            metadata: {
              type: 'string'
              // For remaining properties, see DashboardPartMetadata objects
            }
            position: {
              colSpan: int
              metadata: any(Azure.Bicep.Types.Concrete.AnyType)
              rowSpan: int
              x: int
              y: int
            }
          }
        ]
      }
    ]
    metadata: any(Azure.Bicep.Types.Concrete.AnyType)
  }
  tags: {
    {customized property}: 'string'
  }
}

DashboardPartMetadata objects

Set the type property to specify the type of object.

For Extension/HubsExtension/PartType/MarkdownPart, use:

{
  inputs: [
    any(Azure.Bicep.Types.Concrete.AnyType)
  ]
  settings: {
    content: {
      settings: {
        content: 'string'
        markdownSource: int
        markdownUri: 'string'
        subtitle: 'string'
        title: 'string'
      }
    }
  }
  type: 'Extension/HubsExtension/PartType/MarkdownPart'
}

Property values

DashboardLens

Name Description Value
metadata The dashboard len's metadata. any
order The lens order. int (required)
parts The dashboard parts. DashboardParts[] (required)

DashboardPartMetadata

Name Description Value
type Set to 'Extension/HubsExtension/PartType/MarkdownPart' for type MarkdownPartMetadata. 'Extension/HubsExtension/PartType/MarkdownPart' (required)

DashboardParts

Name Description Value
metadata The dashboard part's metadata. DashboardPartMetadata
position The dashboard's part position. DashboardPartsPosition (required)

DashboardPartsPosition

Name Description Value
colSpan The dashboard's part column span. int (required)
metadata The dashboard part's metadata. any
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)

DashboardPropertiesWithProvisioningState

Name Description Value
lenses The dashboard lenses. DashboardLens[]
metadata The dashboard metadata. any

MarkdownPartMetadata

Name Description Value
inputs Input to dashboard part. any[]
settings Markdown part settings. MarkdownPartMetadataSettings
type The dashboard part metadata type. 'Extension/HubsExtension/PartType/MarkdownPart' (required)

MarkdownPartMetadataSettings

Name Description Value
content The content of markdown part. MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

Name Description Value
settings The setting of the content of markdown part. MarkdownPartMetadataSettingsContentSettings

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

Microsoft.Portal/dashboards

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties The resource-specific properties for this resource. DashboardPropertiesWithProvisioningState
tags Resource tags Dictionary of tag names and values. See Tags in templates

TrackedResourceTags

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
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.

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.

Resource format

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

{
  "type": "Microsoft.Portal/dashboards",
  "apiVersion": "2022-12-01-preview",
  "name": "string",
  "location": "string",
  "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": {}
  },
  "tags": {
    "{customized property}": "string"
  }
}

DashboardPartMetadata objects

Set the type property to specify the type of object.

For Extension/HubsExtension/PartType/MarkdownPart, use:

{
  "inputs": [ {} ],
  "settings": {
    "content": {
      "settings": {
        "content": "string",
        "markdownSource": "int",
        "markdownUri": "string",
        "subtitle": "string",
        "title": "string"
      }
    }
  },
  "type": "Extension/HubsExtension/PartType/MarkdownPart"
}

Property values

DashboardLens

Name Description Value
metadata The dashboard len's metadata. any
order The lens order. int (required)
parts The dashboard parts. DashboardParts[] (required)

DashboardPartMetadata

Name Description Value
type Set to 'Extension/HubsExtension/PartType/MarkdownPart' for type MarkdownPartMetadata. 'Extension/HubsExtension/PartType/MarkdownPart' (required)

DashboardParts

Name Description Value
metadata The dashboard part's metadata. DashboardPartMetadata
position The dashboard's part position. DashboardPartsPosition (required)

DashboardPartsPosition

Name Description Value
colSpan The dashboard's part column span. int (required)
metadata The dashboard part's metadata. any
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)

DashboardPropertiesWithProvisioningState

Name Description Value
lenses The dashboard lenses. DashboardLens[]
metadata The dashboard metadata. any

MarkdownPartMetadata

Name Description Value
inputs Input to dashboard part. any[]
settings Markdown part settings. MarkdownPartMetadataSettings
type The dashboard part metadata type. 'Extension/HubsExtension/PartType/MarkdownPart' (required)

MarkdownPartMetadataSettings

Name Description Value
content The content of markdown part. MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

Name Description Value
settings The setting of the content of markdown part. MarkdownPartMetadataSettingsContentSettings

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

Microsoft.Portal/dashboards

Name Description Value
apiVersion The api version '2022-12-01-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties The resource-specific properties for this resource. DashboardPropertiesWithProvisioningState
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Portal/dashboards'

TrackedResourceTags

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure ML monitoring dashboard

Deploy to Azure		 This template creates an AML dashboard on top of existing Log Analytics workspaces diagnostics data
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.
Deploy a simple Azure Spring Apps microservice application

Deploy to Azure		 This template deploys a simple Azure Spring Apps microservice application to run on Azure.
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.

Terraform (AzAPI provider) resource definition

The dashboards resource type can be deployed with operations that target:

  • 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@2022-12-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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 = ?
    }
  })
}

DashboardPartMetadata objects

Set the type property to specify the type of object.

For Extension/HubsExtension/PartType/MarkdownPart, use:

{
  inputs = [
    ?
  ]
  settings = {
    content = {
      settings = {
        content = "string"
        markdownSource = int
        markdownUri = "string"
        subtitle = "string"
        title = "string"
      }
    }
  }
  type = "Extension/HubsExtension/PartType/MarkdownPart"
}

Property values

DashboardLens

Name Description Value
metadata The dashboard len's metadata. any
order The lens order. int (required)
parts The dashboard parts. DashboardParts[] (required)

DashboardPartMetadata

Name Description Value
type Set to 'Extension/HubsExtension/PartType/MarkdownPart' for type MarkdownPartMetadata. 'Extension/HubsExtension/PartType/MarkdownPart' (required)

DashboardParts

Name Description Value
metadata The dashboard part's metadata. DashboardPartMetadata
position The dashboard's part position. DashboardPartsPosition (required)

DashboardPartsPosition

Name Description Value
colSpan The dashboard's part column span. int (required)
metadata The dashboard part's metadata. any
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)

DashboardPropertiesWithProvisioningState

Name Description Value
lenses The dashboard lenses. DashboardLens[]
metadata The dashboard metadata. any

MarkdownPartMetadata

Name Description Value
inputs Input to dashboard part. any[]
settings Markdown part settings. MarkdownPartMetadataSettings
type The dashboard part metadata type. 'Extension/HubsExtension/PartType/MarkdownPart' (required)

MarkdownPartMetadataSettings

Name Description Value
content The content of markdown part. MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

Name Description Value
settings The setting of the content of markdown part. MarkdownPartMetadataSettingsContentSettings

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

Microsoft.Portal/dashboards

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties The resource-specific properties for this resource. DashboardPropertiesWithProvisioningState
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Portal/dashboards@2022-12-01-preview"

TrackedResourceTags

Name Description Value