Microsoft.Portal ダッシュボード

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 リソース名 string (必須)

文字制限: 3 から 160

有効な文字:
英数字とハイフン。

制限のある文字を使用するには、**hidden-title** という名前のタグを、使用するダッシュボード名とともに追加します。 ポータルでは、ダッシュボードを表示するときにその名前が表示されます。
location リソースの場所 string (必須)
tags リソース タグ タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
properties 共有ダッシュボードのプロパティ。 DashboardProperties

DashboardProperties

名前 説明
レンズ ダッシュボード レンズ。 DashboardLens[]
metadata ダッシュボードのメタデータ。 object

DashboardLens

名前 説明
metadata ダッシュボード len のメタデータ。 object
順序 レンズの順序。 int (必須)
のコンポーネント ダッシュボード パーツ。 DashboardParts[] (必須)

DashboardParts

名前 説明
metadata ダッシュボード パーツのメタデータ。 DashboardPartMetadata
position ダッシュボードのパーツ位置。 DashboardPartsPosition (必須)

DashboardPartMetadata

名前 説明
type オブジェクトの種類を設定する Extension/HubsExtension/PartType/MarkdownPart (必須)

MarkdownPartMetadata

名前 説明
type ダッシュボード パーツの種類。 'Extension/HubsExtension/PartType/MarkdownPart' (必須)
inputs ダッシュボード パーツへの入力。 any[]
settings マークダウン パーツの設定。 MarkdownPartMetadataSettings

MarkdownPartMetadataSettings

名前 説明
content マークダウン パーツの内容。 MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

名前 説明
settings マークダウン パーツの内容の設定。 MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

名前 説明
content マークダウン パーツの内容。 string
markdownSource マークダウン パーツのコンテンツのソース。 INT
markdownUri マークダウン コンテンツの URI。 string
subtitle マークダウン 部分のサブタイトル。 string
title マークダウン パーツのタイトル。 string

DashboardPartsPosition

名前 説明
colSpan ダッシュボードのパーツ列スパン。 int (必須)
metadata ダッシュボード パーツのメタデータ。 object
rowSpan ダッシュボードのパーツ行スパン。 int (必須)
x ダッシュボードのパーツ x 座標。 int (必須)
ダッシュボードのパート y 座標。 int (必須)

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
単純な Azure Spring Apps マイクロサービス アプリケーションをデプロイする

Azure にデプロイする
このテンプレートでは、Azure で実行する単純な Azure Spring Apps マイクロサービス アプリケーションをデプロイします。
Azure ML 監視ダッシュボードを作成する

Azure にデプロイする
このテンプレートは、既存の Log Analytics ワークスペース診断データの上に AML ダッシュボードを作成します
Azure portal ダッシュボードを作成する

Azure にデプロイする
このテンプレートは、サブスクリプション内の既存の仮想マシンのパフォーマンスと静的な情報とリンクを示すダッシュボードの例をAzure portalに作成します。
共有の既定のダッシュボード

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

名前 説明
type リソースの種類 'Microsoft.Portal/dashboards'
apiVersion リソース API のバージョン '2020-09-01-preview'
name リソース名 string (必須)

文字制限: 3 から 160

有効な文字:
英数字とハイフン。

制限のある文字を使用するには、**hidden-title** という名前のタグを、使用するダッシュボード名とともに追加します。 ポータルでは、ダッシュボードを表示するときにその名前が表示されます。
location リソースの場所 string (必須)
tags リソース タグ タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
properties 共有ダッシュボードのプロパティ。 DashboardProperties

DashboardProperties

名前 説明
レンズ ダッシュボード レンズ。 DashboardLens[]
metadata ダッシュボードのメタデータ。 object

DashboardLens

名前 説明
metadata ダッシュボード len のメタデータ。 object
順序 レンズの順序。 int (必須)
のコンポーネント ダッシュボード パーツ。 DashboardParts[] (必須)

DashboardParts

名前 説明
metadata ダッシュボード パーツのメタデータ。 DashboardPartMetadata
position ダッシュボードのパーツ位置。 DashboardPartsPosition (必須)

DashboardPartMetadata

名前 説明
type オブジェクトの種類を設定する Extension/HubsExtension/PartType/MarkdownPart (必須)

MarkdownPartMetadata

名前 説明
type ダッシュボード パーツの種類。 'Extension/HubsExtension/PartType/MarkdownPart' (必須)
inputs ダッシュボード パーツへの入力。 any[]
settings マークダウン パーツの設定。 MarkdownPartMetadataSettings

MarkdownPartMetadataSettings

名前 説明
content マークダウン パーツの内容。 MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

名前 説明
settings マークダウン パーツの内容の設定。 MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

名前 説明
content マークダウン パーツの内容。 string
markdownSource マークダウン パーツのコンテンツのソース。 INT
markdownUri マークダウン コンテンツの URI。 string
subtitle マークダウン 部分のサブタイトル。 string
title マークダウン パーツのタイトル。 string

DashboardPartsPosition

名前 説明
colSpan ダッシュボードのパーツ列スパン。 int (必須)
metadata ダッシュボード パーツのメタデータ。 object
rowSpan ダッシュボードのパーツ行スパン。 int (必須)
x ダッシュボードのパーツ x 座標。 int (必須)
ダッシュボードのパート y 座標。 int (必須)

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
単純な Azure Spring Apps マイクロサービス アプリケーションをデプロイする

Azure にデプロイする
このテンプレートでは、Azure で実行する単純な Azure Spring Apps マイクロサービス アプリケーションをデプロイします。
Azure ML 監視ダッシュボードを作成する

Azure にデプロイする
このテンプレートは、既存の Log Analytics ワークスペース診断データの上に AML ダッシュボードを作成します
Azure portal ダッシュボードを作成する

Azure にデプロイする
このテンプレートは、サブスクリプション内の既存の仮想マシンのパフォーマンスと静的な情報とリンクを示すダッシュボードの例をAzure portalに作成します。
共有の既定のダッシュボード

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

名前 説明
type リソースの種類 "Microsoft.Portal/dashboards@2020-09-01-preview"
name リソース名 string (必須)

文字制限: 3 から 160

有効な文字:
英数字とハイフン。

制限のある文字を使用するには、**hidden-title** という名前のタグを、使用するダッシュボード名とともに追加します。 ポータルでは、ダッシュボードを表示するときにその名前が表示されます。
location リソースの場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ タグの名前と値のディクショナリ。
properties 共有ダッシュボードのプロパティ。 DashboardProperties

DashboardProperties

名前 説明
レンズ ダッシュボード レンズ。 DashboardLens[]
metadata ダッシュボードのメタデータ。 object

DashboardLens

名前 説明
metadata ダッシュボード len のメタデータ。 object
順序 レンズの順序。 int (必須)
のコンポーネント ダッシュボード パーツ。 DashboardParts[] (必須)

DashboardParts

名前 説明
metadata ダッシュボード パーツのメタデータ。 DashboardPartMetadata
position ダッシュボードのパーツ位置。 DashboardPartsPosition (必須)

DashboardPartMetadata

名前 説明
type オブジェクトの種類を設定する Extension/HubsExtension/PartType/MarkdownPart (必須)

MarkdownPartMetadata

名前 説明
type ダッシュボード パーツの種類。 "Extension/HubsExtension/PartType/MarkdownPart" (必須)
inputs ダッシュボード パーツへの入力。 any[]
settings Markdown パーツの設定。 MarkdownPartMetadataSettings

MarkdownPartMetadataSettings

名前 説明
content マークダウン パーツの内容。 MarkdownPartMetadataSettingsContent

MarkdownPartMetadataSettingsContent

名前 説明
settings マークダウン パーツの内容の設定。 MarkdownPartMetadataSettingsContentSettings

MarkdownPartMetadataSettingsContentSettings

名前 説明
content マークダウン パーツの内容。 string
markdownSource マークダウン パーツのコンテンツのソース。 INT
markdownUri マークダウン コンテンツの URI。 string
subtitle マークダウン 部分のサブタイトル。 string
title マークダウン パーツのタイトル。 string

DashboardPartsPosition

名前 説明
colSpan ダッシュボードのパーツ列スパン。 int (必須)
metadata ダッシュボード パーツのメタデータ。 object
rowSpan ダッシュボードのパート行スパン。 int (必須)
x ダッシュボードのパーツ x 座標。 int (必須)
ダッシュボードのパート y 座標。 int (必須)