Microsoft.Portal 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@2025-04-01-preview' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    lenses: [
      {
        metadata: any(...)
        order: int
        parts: [
          {
            metadata: {
              type: 'string'
              // For remaining properties, see DashboardPartMetadata objects
            }
            position: {
              colSpan: int
              metadata: any(...)
              rowSpan: int
              x: int
              y: int
            }
          }
        ]
      }
    ]
    metadata: any(...)
  }
  tags: {
    {customized property}: 'string'
  }
}

DashboardPartMetadata objects

Set the type property to specify the type of object.

For Extension/HubsExtension/PartType/MarkdownPart, use:

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

Property Values

Microsoft.Portal/dashboards

DashboardLens

DashboardPartMetadata

DashboardParts

DashboardPartsPosition

DashboardPropertiesWithProvisioningState

MarkdownPartMetadata

MarkdownPartMetadataSettings

MarkdownPartMetadataSettingsContent

TrackedResourceTags

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying 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.

Resource format

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

{
  "type": "Microsoft.Portal/dashboards",
  "apiVersion": "2025-04-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": {
      "content": "string",
      "markdownSource": "int",
      "markdownUri": "string",
      "subtitle": "string",
      "title": "string"
    }
  },
  "type": "Extension/HubsExtension/PartType/MarkdownPart"
}

Property Values

Microsoft.Portal/dashboards

DashboardLens

DashboardPartMetadata

DashboardParts

DashboardPartsPosition

DashboardPropertiesWithProvisioningState

MarkdownPartMetadata

MarkdownPartMetadataSettings

MarkdownPartMetadataSettingsContent

TrackedResourceTags

Usage Examples

Azure Quickstart Templates

The following Azure 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.

Terraform (AzAPI provider) 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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Portal/dashboards@2025-04-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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 = {
      content = "string"
      markdownSource = int
      markdownUri = "string"
      subtitle = "string"
      title = "string"
    }
  }
  type = "Extension/HubsExtension/PartType/MarkdownPart"
}

Property Values

Microsoft.Portal/dashboards

DashboardLens

DashboardPartMetadata

DashboardParts

DashboardPartsPosition

DashboardPropertiesWithProvisioningState

MarkdownPartMetadata

MarkdownPartMetadataSettings

MarkdownPartMetadataSettingsContent

TrackedResourceTags

Usage Examples

Terraform Samples

A basic example of deploying shared dashboard in the Azure Portal.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "dashboard" {
  type      = "Microsoft.Portal/dashboards@2019-01-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      lenses = {
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.