az grafana dashboard

Note

このリファレンスは、Azure CLI (バージョン 2.61.0 以降) の amg 拡張機能の一部です。 拡張機能は、 az grafana dashboard コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

インスタンスのダッシュボードを管理するコマンド。

コマンド

名前	説明	型	状態
az grafana dashboard create	新しいダッシュボードを作成します。	拡張子	GA
az grafana dashboard delete	ダッシュボードを削除します。	拡張子	GA
az grafana dashboard import	ダッシュボードをインポートします。	拡張子	GA
az grafana dashboard list	インスタンスのすべてのダッシュボードを一覧表示します。	拡張子	GA
az grafana dashboard show	ダッシュボードの詳細を取得します。	拡張子	GA
az grafana dashboard sync	Azure Managed Grafana ダッシュボードを 1 つのインスタンスから別のインスタンスに同期します。 ダッシュボード内のライブラリ パネルは、同期に自動的に含まれます。読み取り専用であるため、"プロビジョニング済み" 状態のダッシュボードはスキップされることに注意してください。	拡張子	プレビュー
az grafana dashboard update	ダッシュボードを更新します。	拡張子	GA

az grafana dashboard create

新しいダッシュボードを作成します。

az grafana dashboard create --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]
                            [--title]

例

json ファイルに定義を含むダッシュボードを作成します。 クイック スタートでは、"az grafana dashboard show" の出力から複製し、"id" と "uid" を削除して、変更を適用します。

az grafana dashboard create -g MyResourceGroup -n MyGrafana --title "My dashboard" --folder folder1 --definition '{
  "dashboard": {
    "annotations": {
        ...
    },
    "panels": {
        ...
    }
  },
  "message": "Create a new test dashboard"
}'

必須のパラメーター

--definition

JSON 文字列内の完全なダッシュボード モデル、そのようなコンテンツを含むファイルへのパスまたは URL。

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--api-key --token -t

API キーまたはサービス アカウント トークン。Grafana エンドポイントとの対話に使用されるランダムに生成された文字列。存在しない場合、CLI は現在ログインしているユーザーの資格情報を使用します。

--folder

フォルダーを識別できる Uid またはタイトル。 一致するものが見つかるまで、CLI は最初に uid、次にタイトルで検索します。

--overwrite

ダッシュボードを同じ uid で上書きします。

指定可能な値: false, true

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--title

ダッシュボードのタイトル。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az grafana dashboard delete

ダッシュボードを削除します。

az grafana dashboard delete --dashboard
                            --name
                            [--api-key]
                            [--resource-group]

例

一意識別子で指定されたダッシュボードを削除します ("az grafana dashboard list" コマンドを使用して uid を取得します)

az grafana dashboard delete -g MyResourceGroup -n MyGrafana --dashboard VdrOA7jGz

必須のパラメーター

--dashboard

ダッシュボード uid。

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--api-key --token -t

API キーまたはサービス アカウント トークン。Grafana エンドポイントとの対話に使用されるランダムに生成された文字列。存在しない場合、CLI は現在ログインしているユーザーの資格情報を使用します。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az grafana dashboard import

ダッシュボードをインポートします。

CLI コマンドは、構成されている場合、データ ソースに必要なパラメーターを入力します。

az grafana dashboard import --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

例

Grafana ギャラリーから "AKS Container Insights" のダッシュボードをインポートします。

az grafana dashboard import -g MyResourceGroup -n MyGrafana --definition 12180

ファイルからダッシュボードをインポートします。

az grafana dashboard import -g MyResourceGroup -n MyGrafana --definition @c:\temp\dashboard.json

必須のパラメーター

--definition

JSON 文字列の完全なダッシュボード モデル、Grafana ギャラリー ID、そのようなコンテンツを含むファイルへのパスまたは URL。

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--api-key --token -t

API キーまたはサービス アカウント トークン。Grafana エンドポイントとの対話に使用されるランダムに生成された文字列。存在しない場合、CLI は現在ログインしているユーザーの資格情報を使用します。

--folder

フォルダーを識別できる Uid またはタイトル。 一致するものが見つかるまで、CLI は最初に uid、次にタイトルで検索します。

--overwrite

ダッシュボードを同じ uid で上書きします。

指定可能な値: false, true

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az grafana dashboard list

インスタンスのすべてのダッシュボードを一覧表示します。

az grafana dashboard list --name
                          [--api-key]
                          [--resource-group]

例

K8s API Server のダッシュボードを検索し、一意の識別子を取得します ("az grafana dashboard show" コマンドを呼び出すために)

az grafana dashboard list -g MyResourceGroup -n MyGrafana --query "[?contains(@.title, 'API server')].uid"

必須のパラメーター

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--api-key --token -t

API キーまたはサービス アカウント トークン。Grafana エンドポイントとの対話に使用されるランダムに生成された文字列。存在しない場合、CLI は現在ログインしているユーザーの資格情報を使用します。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az grafana dashboard show

ダッシュボードの詳細を取得します。

az grafana dashboard show --dashboard
                          --name
                          [--api-key]
                          [--resource-group]

例

一意識別子で指定されたダッシュボードの詳細を取得します ("az grafana dashboard list" コマンドを使用して uid を取得します)

az grafana dashboard show -g MyResourceGroup -n MyGrafana --dashboard VdrOA7jGz

必須のパラメーター

--dashboard

ダッシュボード uid。

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--api-key --token -t

API キーまたはサービス アカウント トークン。Grafana エンドポイントとの対話に使用されるランダムに生成された文字列。存在しない場合、CLI は現在ログインしているユーザーの資格情報を使用します。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az grafana dashboard sync

プレビュー

このコマンドはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure Managed Grafana ダッシュボードを 1 つのインスタンスから別のインスタンスに同期します。 ダッシュボード内のライブラリ パネルは、同期に自動的に含まれます。読み取り専用であるため、"プロビジョニング済み" 状態のダッシュボードはスキップされることに注意してください。

az grafana dashboard sync --destination
                          --source
                          [--dashboards-to-exclude]
                          [--dashboards-to-include]
                          [--dry-run {false, true}]
                          [--folders-to-exclude]
                          [--folders-to-include]

例

いくつかのフォルダーの下にあるダッシュボードのみを同期する

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --folders-to-include "Azure Monitor Container Insights" "Azure Monitor"

1 つのダッシュボードを同期する

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --folders-to-include "MyFolder" --dashboards-to-include "My Service Health"

同期をプレビューする

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --dry-run

必須のパラメーター

--destination -d

移動先ワークスペースのリソース ID。

--source -s

ソース ワークスペースのリソース ID。

省略可能のパラメーター

--dashboards-to-exclude

同期で除外するダッシュボードのスペース区切りタイトル。フォルダー固有の --folders-to-exclude とペアにします。

--dashboards-to-include

同期に含めるダッシュボードのスペース区切りタイトル。フォルダー固有の --folders-to-include とペアにします。

--dry-run

コミット時に変更をプレビューします。

指定可能な値: false, true

--folders-to-exclude -e

バックアップまたは同期で除外するフォルダー。

--folders-to-include -i

バックアップまたは同期に含めるフォルダー。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az grafana dashboard update

ダッシュボードを更新します。

az grafana dashboard update --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

例

json ファイル内の定義を使用してダッシュボードを更新します。 クイック スタートでは、"az grafana dashboard show" から既存の構成を取得し、変更を適用します。 "version" フィールドは更新する必要があり、"overwrite" フィールドは true にする必要があります。

az grafana dashboard update -g MyResourceGroup -n MyGrafana --definition @c:\temp\dashboard.json

必須のパラメーター

--definition

JSON 文字列内の完全なダッシュボード モデル、そのようなコンテンツを含むファイルへのパスまたは URL。

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--api-key --token -t

API キーまたはサービス アカウント トークン。Grafana エンドポイントとの対話に使用されるランダムに生成された文字列。存在しない場合、CLI は現在ログインしているユーザーの資格情報を使用します。

--folder

フォルダーを識別できる Uid またはタイトル。 一致するものが見つかるまで、CLI は最初に uid、次にタイトルで検索します。

--overwrite

ダッシュボードを同じ uid で上書きします。

指定可能な値: false, true

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。