你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Portal 仪表板

• 最新
• 2020-09-01-preview
• 2019-01-01-preview
• 2018-10-01-preview
• 2015-08-01-preview

Bicep 资源定义

可以将仪表板资源类型部署到：

• 资源组 - 请参阅 资源组部署命令

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

注解

有关创建仪表板的详细信息，请参阅 Azure 仪表板的结构。

资源格式

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

resource symbolicname 'Microsoft.Portal/dashboards@2020-09-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  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 对象

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

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

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

属性值

dashboards

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：3-160 有效字符： 字母数字和连字符。 若要使用受限字符，请添加名为 hidden-title 的标记以及要使用的仪表板名称。 显示仪表板时，门户会显示该名称。
location	资源位置	字符串 (必需)
标记	资源标记	标记名称和值的字典。 请参阅 模板中的标记
properties	共享仪表板属性。	DashboardProperties

DashboardProperties

名称	说明	值
镜头	仪表板镜头。	DashboardLens[]
metadata	仪表板元数据。	对象 (object)

DashboardLens

名称	说明	值
metadata	仪表板 len 的元数据。	对象 (object)
顺序	镜头顺序。	int (必需)
部件	仪表板部分。	DashboardParts[] (必需的)

DashboardParts

名称	说明	值
metadata	仪表板部件的元数据。	DashboardPartMetadata
position	仪表板的部件位置。	DashboardPartsPosition (必需)

DashboardPartMetadata

名称	说明	Value
type	设置对象类型	Extension/HubsExtension/PartType/MarkdownPart (必需)

MarkdownPartMetadata

名称	说明	Value
type	仪表板部件的类型。	“Extension/HubsExtension/PartType/MarkdownPart” (必需)
inputs	输入到仪表板部件。	any[]
设置	Markdown 部件设置。	MarkdownPartMetadataSettings

MarkdownPartMetadataSettings

名称	说明	Value
content	markdown 部件的内容。	MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

名称	说明	值
设置	markdown 部件内容的设置。	MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

名称	说明	Value
content	markdown 部件的内容。	string
markdownSource	markdown 部件内容的源。	int
markdownUri	markdown 内容的 URI。	string
副标题	markdown 部分的副标题。	字符串
title	markdown 部件的标题。	字符串

DashboardPartsPosition

名称	说明	值
colSpan	仪表板的部件列范围。	int (必需)
metadata	仪表板部件的元数据。	对象 (object)
rowSpan	仪表板的部件行范围。	int (必需)
x	仪表板的第 x 部分坐标。	int (必需)
y	仪表板部分 y 坐标。	int (必需)

快速入门模板

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

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

ARM 模板资源定义

可以将仪表板资源类型部署到：

• 资源组 - 请参阅 资源组部署命令

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

注解

有关创建仪表板的详细信息，请参阅 Azure 仪表板的结构。

资源格式

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

{
  "type": "Microsoft.Portal/dashboards",
  "apiVersion": "2020-09-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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 对象

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

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

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

属性值

dashboards

名称	说明	Value
type	资源类型	“Microsoft.Portal/dashboards”
apiVersion	资源 API 版本	“2020-09-01-preview”
name	资源名称	字符串 (必需) 字符限制：3-160 有效字符： 字母数字和连字符。 若要使用受限字符，请添加名为 hidden-title 的标记以及要使用的仪表板名称。 显示仪表板时，门户会显示该名称。
location	资源位置	字符串 (必需)
标记	资源标记	标记名称和值的字典。 请参阅 模板中的标记
properties	共享仪表板属性。	DashboardProperties

DashboardProperties

名称	说明	值
镜头	仪表板镜头。	DashboardLens[]
metadata	仪表板元数据。	对象 (object)

DashboardLens

名称	说明	值
metadata	仪表板 len 的元数据。	对象 (object)
顺序	镜头顺序。	int (必需)
部件	仪表板部分。	DashboardParts[] (必需的)

DashboardParts

名称	说明	值
metadata	仪表板部件的元数据。	DashboardPartMetadata
position	仪表板的部件位置。	DashboardPartsPosition (必需)

DashboardPartMetadata

名称	说明	Value
type	设置对象类型	Extension/HubsExtension/PartType/MarkdownPart (必需)

MarkdownPartMetadata

名称	说明	Value
type	仪表板部件的类型。	“Extension/HubsExtension/PartType/MarkdownPart” (必需)
inputs	输入到仪表板部件。	any[]
设置	Markdown 部件设置。	MarkdownPartMetadataSettings

MarkdownPartMetadataSettings

名称	说明	Value
content	markdown 部件的内容。	MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

名称	说明	值
设置	markdown 部件内容的设置。	MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

名称	说明	Value
content	markdown 部件的内容。	字符串
markdownSource	markdown 部件内容的源。	int
markdownUri	markdown 内容的 URI。	string
副标题	markdown 部分的副标题。	string
title	markdown 部件的标题。	string

DashboardPartsPosition

名称	说明	值
colSpan	仪表板的部件列范围。	int (必需)
metadata	仪表板部件的元数据。	对象 (object)
rowSpan	仪表板的部件行跨度。	int (必需)
x	仪表板的第 x 部分坐标。	int (必需)
y	仪表板部分 y 坐标。	int (必需)

快速入门模板

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

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

Terraform (AzAPI 提供程序) 资源定义

可以将仪表板资源类型部署到：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Portal/dashboards@2020-09-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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 对象

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

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

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

属性值

dashboards

名称	说明	Value
type	资源类型	“Microsoft.Portal/dashboards@2020-09-01-preview”
name	资源名称	字符串 (必需) 字符限制：3-160 有效字符： 字母数字和连字符。 若要使用受限字符，请添加名为 hidden-title 的标记以及要使用的仪表板名称。 显示仪表板时，门户会显示该名称。
location	资源位置	字符串 (必需)
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记	标记名称和值的字典。
properties	共享仪表板属性。	DashboardProperties

DashboardProperties

名称	说明	值
镜头	仪表板镜头。	DashboardLens[]
metadata	仪表板元数据。	对象 (object)

DashboardLens

名称	说明	值
metadata	仪表板 len 的元数据。	对象 (object)
顺序	镜头顺序。	int (必需)
部件	仪表板部分。	DashboardParts[] (必需)

DashboardParts

名称	说明	值
metadata	仪表板部件的元数据。	DashboardPartMetadata
position	仪表板的部件位置。	DashboardPartsPosition (必需)

DashboardPartMetadata

名称	说明	Value
type	设置对象类型	Extension/HubsExtension/PartType/MarkdownPart (必需)

MarkdownPartMetadata

名称	说明	Value
type	仪表板部件的类型。	“Extension/HubsExtension/PartType/MarkdownPart” (必需)
inputs	输入到仪表板部件。	any[]
设置	Markdown 部件设置。	MarkdownPartMetadataSettings

MarkdownPartMetadataSettings

名称	说明	Value
content	Markdown 部件的内容。	MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

名称	说明	值
设置	Markdown 部分内容的设置。	MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

名称	说明	Value
content	Markdown 部分的内容。	字符串
markdownSource	Markdown 部分的内容源。	int
markdownUri	markdown 内容的 URI。	string
副标题	Markdown 部分的副标题。	字符串
title	Markdown 部件的标题。	string

DashboardPartsPosition

名称	说明	值
colSpan	仪表板的部件列范围。	int (必需)
metadata	仪表板部件的元数据。	对象 (object)
rowSpan	仪表板的部件行跨度。	int (必需)
x	仪表板的第 x 部分坐标。	int (必需)
y	仪表板部分 y 坐标。	int (必需)