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

Microsoft.Portal 仪表板

言论

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

Bicep 资源定义

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

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

资源格式

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

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

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

对于 Extension/HubsExtension/PartType/MarkdownPart,请使用:

{
  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'
}

属性值

DashboardLens

名字 描述 价值
元数据 仪表板 len 的元数据。 任何
次序 镜头顺序。 int (必需)
部件 仪表板部件。 DashboardParts[] (必需)

DashboardPartMetadata

名字 描述 价值
类型 对于 MarkdownPartMetadata,请设置为“Extension/HubsExtension/PartType/MarkdownPart”。 “Extension/HubsExtension/PartType/MarkdownPart”(必需)

DashboardParts

名字 描述 价值
元数据 仪表板部件的元数据。 DashboardPartMetadata
位置 仪表板的部件位置。 DashboardPartsPosition (必需)

DashboardPartsPosition

名字 描述 价值
colSpan 仪表板的部件列范围。 int (必需)
元数据 仪表板部件的元数据。 任何
rowSpan 仪表板的部件行范围。 int (必需)
x 仪表板的第 x 部分坐标。 int (必需)
y 仪表板的部分 y 坐标。 int (必需)

DashboardPropertiesWithProvisioningState

名字 描述 价值
镜头 仪表板镜头。 DashboardLens[]
元数据 仪表板元数据。 任何

MarkdownPartMetadata

名字 描述 价值
输入 仪表板部件的输入。 any[]
设置 Markdown 部件设置。 MarkdownPartMetadataSettings
类型 仪表板部件元数据类型。 “Extension/HubsExtension/PartType/MarkdownPart”(必需)

MarkdownPartMetadataSettings

名字 描述 价值
内容 markdown 部件的内容。 MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

名字 描述 价值
设置 Markdown 部件内容的设置。 MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

名字 描述 价值
内容 markdown 部件的内容。 字符串
markdownSource Markdown 部件内容的源。 int
markdownUri markdown 内容的 URI。 字符串
字幕 Markdown 部件的副标题。 字符串
标题 Markdown 部件的标题。 字符串

Microsoft.Portal/dashboards

名字 描述 价值
位置 资源所在的地理位置 string (必需)
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 3
模式 = ^[a-zA-Z0-9-]{3,24}$ (必需)
性能 此资源的资源特定属性。 DashboardPropertiesWithProvisioningState
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

TrackedResourceTags

名字 描述 价值

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
创建 Azure 门户仪表板 此模板在 Azure 门户中创建示例仪表板,其中显示了订阅中现有虚拟机的性能,以及一些静态信息和链接。
部署简单的 Azure Spring Apps 微服务应用程序 此模板部署一个简单的 Azure Spring Apps 微服务应用程序,以在 Azure 上运行。

ARM 模板资源定义

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

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

资源格式

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

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

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

对于 Extension/HubsExtension/PartType/MarkdownPart,请使用:

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

属性值

DashboardLens

名字 描述 价值
元数据 仪表板 len 的元数据。 任何
次序 镜头顺序。 int (必需)
部件 仪表板部件。 DashboardParts[] (必需)

DashboardPartMetadata

名字 描述 价值
类型 对于 MarkdownPartMetadata,请设置为“Extension/HubsExtension/PartType/MarkdownPart”。 “Extension/HubsExtension/PartType/MarkdownPart”(必需)

DashboardParts

名字 描述 价值
元数据 仪表板部件的元数据。 DashboardPartMetadata
位置 仪表板的部件位置。 DashboardPartsPosition (必需)

DashboardPartsPosition

名字 描述 价值
colSpan 仪表板的部件列范围。 int (必需)
元数据 仪表板部件的元数据。 任何
rowSpan 仪表板的部件行范围。 int (必需)
x 仪表板的第 x 部分坐标。 int (必需)
y 仪表板的部分 y 坐标。 int (必需)

DashboardPropertiesWithProvisioningState

名字 描述 价值
镜头 仪表板镜头。 DashboardLens[]
元数据 仪表板元数据。 任何

MarkdownPartMetadata

名字 描述 价值
输入 仪表板部件的输入。 any[]
设置 Markdown 部件设置。 MarkdownPartMetadataSettings
类型 仪表板部件元数据类型。 “Extension/HubsExtension/PartType/MarkdownPart”(必需)

MarkdownPartMetadataSettings

名字 描述 价值
内容 markdown 部件的内容。 MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

名字 描述 价值
设置 Markdown 部件内容的设置。 MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

名字 描述 价值
内容 markdown 部件的内容。 字符串
markdownSource Markdown 部件内容的源。 int
markdownUri markdown 内容的 URI。 字符串
字幕 Markdown 部件的副标题。 字符串
标题 Markdown 部件的标题。 字符串

Microsoft.Portal/dashboards

名字 描述 价值
apiVersion API 版本 '2022-12-01-preview'
位置 资源所在的地理位置 string (必需)
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 3
模式 = ^[a-zA-Z0-9-]{3,24}$ (必需)
性能 此资源的资源特定属性。 DashboardPropertiesWithProvisioningState
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Portal/dashboards”

TrackedResourceTags

名字 描述 价值

快速入门模板

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

模板 描述
创建 Azure ML 监视仪表板

部署到 Azure
此模板在现有 Log Analytics 工作区诊断数据的基础上创建 AML 仪表板
创建 Azure 门户仪表板

部署到 Azure
此模板在 Azure 门户中创建示例仪表板,其中显示了订阅中现有虚拟机的性能,以及一些静态信息和链接。
部署简单的 Azure Spring Apps 微服务应用程序

部署到 Azure
此模板部署一个简单的 Azure Spring Apps 微服务应用程序,以在 Azure 上运行。
共享的默认仪表板

部署到 Azure
为了使应用程序正常运行,它有助于获得构成系统的服务的共享仪表板视图。 此仪表板提供了一个快速入门,用于自定义和共享团队中的其他人。

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

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

  • 资源组

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

资源格式

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

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

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

对于 Extension/HubsExtension/PartType/MarkdownPart,请使用:

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

属性值

DashboardLens

名字 描述 价值
元数据 仪表板 len 的元数据。 任何
次序 镜头顺序。 int (必需)
部件 仪表板部件。 DashboardParts[] (必需)

DashboardPartMetadata

名字 描述 价值
类型 对于 MarkdownPartMetadata,请设置为“Extension/HubsExtension/PartType/MarkdownPart”。 “Extension/HubsExtension/PartType/MarkdownPart”(必需)

DashboardParts

名字 描述 价值
元数据 仪表板部件的元数据。 DashboardPartMetadata
位置 仪表板的部件位置。 DashboardPartsPosition (必需)

DashboardPartsPosition

名字 描述 价值
colSpan 仪表板的部件列范围。 int (必需)
元数据 仪表板部件的元数据。 任何
rowSpan 仪表板的部件行范围。 int (必需)
x 仪表板的第 x 部分坐标。 int (必需)
y 仪表板的部分 y 坐标。 int (必需)

DashboardPropertiesWithProvisioningState

名字 描述 价值
镜头 仪表板镜头。 DashboardLens[]
元数据 仪表板元数据。 任何

MarkdownPartMetadata

名字 描述 价值
输入 仪表板部件的输入。 any[]
设置 Markdown 部件设置。 MarkdownPartMetadataSettings
类型 仪表板部件元数据类型。 “Extension/HubsExtension/PartType/MarkdownPart”(必需)

MarkdownPartMetadataSettings

名字 描述 价值
内容 markdown 部件的内容。 MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

名字 描述 价值
设置 Markdown 部件内容的设置。 MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

名字 描述 价值
内容 markdown 部件的内容。 字符串
markdownSource Markdown 部件内容的源。 int
markdownUri markdown 内容的 URI。 字符串
字幕 Markdown 部件的副标题。 字符串
标题 Markdown 部件的标题。 字符串

Microsoft.Portal/dashboards

名字 描述 价值
位置 资源所在的地理位置 string (必需)
名字 资源名称 字符串

约束:
最小长度 = 3
最大长度 = 3
模式 = ^[a-zA-Z0-9-]{3,24}$ (必需)
性能 此资源的资源特定属性。 DashboardPropertiesWithProvisioningState
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Portal/dashboards@2022-12-01-preview”

TrackedResourceTags

名字 描述 价值