Microsoft.Portal 仪表板

Bicep 资源定义

可以使用目标操作部署仪表板资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Portal/dashboards 资源，请将以下 Bicep 添加到模板。

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 对象

设置 类型 属性以指定对象的类型。

对于 Extension/HubsExtension/PartType/MarkdownPart，请使用：

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

属性值

Microsoft.Portal/仪表板

仪表板镜头

DashboardPartMetadata

仪表板部件

DashboardPartsPosition

DashboardPropertiesWithProvisioningState

MarkdownPartMetadata

MarkdownPartMetadataSettings

MarkdownPartMetadataSettingsContent

TrackedResourceTags

用法示例

Azure 验证模块

以下 Azure 验证模块 可用于部署此资源类型。

Azure 快速入门示例

以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。

ARM 模板资源定义

可以使用目标操作部署仪表板资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Portal/dashboards 资源，请将以下 JSON 添加到模板。

{
  "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 对象

设置 类型 属性以指定对象的类型。

对于 Extension/HubsExtension/PartType/MarkdownPart，请使用：

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

属性值

Microsoft.Portal/仪表板

仪表板镜头

DashboardPartMetadata

仪表板部件

DashboardPartsPosition

DashboardPropertiesWithProvisioningState

MarkdownPartMetadata

MarkdownPartMetadataSettings

MarkdownPartMetadataSettingsContent

TrackedResourceTags

用法示例

Azure 快速入门模板

以下 Azure 快速入门模板 部署此资源类型。

模板	描述
创建 Azure ML 监视仪表板	此模板在现有 Log Analytics 工作区诊断数据的基础上创建 AML 仪表板
创建 Azure 门户仪表板	此模板在 Azure 门户中创建示例仪表板，其中显示了订阅中现有虚拟机的性能，以及一些静态信息和链接。
部署简单的 Azure Spring Apps 微服务应用程序	此模板部署一个简单的 Azure Spring Apps 微服务应用程序，以在 Azure 上运行。
共享的默认仪表板	为了使应用程序正常运行，它有助于获得构成系统的服务的共享仪表板视图。 此仪表板提供了一个快速入门，用于自定义和共享团队中的其他人。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署仪表板资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Portal/dashboards 资源，请将以下 Terraform 添加到模板。

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 对象

设置 类型 属性以指定对象的类型。

对于 Extension/HubsExtension/PartType/MarkdownPart，请使用：

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

属性值

Microsoft.Portal/仪表板

仪表板镜头

DashboardPartMetadata

仪表板部件

DashboardPartsPosition

DashboardPropertiesWithProvisioningState

MarkdownPartMetadata

MarkdownPartMetadataSettings

MarkdownPartMetadataSettingsContent

TrackedResourceTags

用法示例

Terraform 示例

在 Azure 门户中部署共享仪表板的基本示例。

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 验证模块

以下 Azure 验证模块 可用于部署此资源类型。