az grafana

Note

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

Azure Grafana インスタンスを管理するためのコマンド。

最適化されたエクスペリエンスのために、ドキュメントに記載 https://grafana.com/docs/grafana/latest/http_api/されているすべてのデータ プレーン API が公開されているわけではありません。 カバレッジギャップに関して、に手を差し ad4g@microsoft.com伸べてください.

コマンド

名前	説明	型	Status
az grafana api-key	API キーを管理するコマンド。	拡張子	GA
az grafana api-key create	新しい API キーを作成します。	拡張子	GA
az grafana api-key delete	API キーを削除します。	拡張子	GA
az grafana api-key list	既存の API キーを一覧表示します。	拡張子	GA
az grafana backup	Azure Managed Grafana インスタンスのコンテンツをアーカイブにバックアップします。	拡張子	プレビュー
az grafana create	Azure Managed Grafana インスタンスを作成します。	拡張子	GA
az grafana dashboard	インスタンスのダッシュボードを管理するコマンド。	拡張子	GA
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 data-source	インスタンスのデータ ソースを管理するコマンド。	拡張子	GA
az grafana data-source create	データ ソースを作成します。	拡張子	GA
az grafana data-source delete	データ ソースを削除します。	拡張子	GA
az grafana data-source list	インスタンスのすべてのデータ ソースを一覧表示します。	拡張子	GA
az grafana data-source query	バックエンド実装を持つデータ ソースに対してクエリを実行します。	拡張子	GA
az grafana data-source show	データ ソースの詳細を取得します。	拡張子	GA
az grafana data-source update	データ ソースを更新します。	拡張子	GA
az grafana delete	Azure Managed Grafana インスタンスを削除します。	拡張子	GA
az grafana folder	インスタンスのフォルダーを管理するコマンド。	拡張子	GA
az grafana folder create	新しいフォルダーを作成する。	拡張子	GA
az grafana folder delete	フォルダーを削除します。	拡張子	GA
az grafana folder list	インスタンスのすべてのフォルダーを一覧表示します。	拡張子	GA
az grafana folder show	フォルダーの詳細を取得します。	拡張子	GA
az grafana folder update	フォルダーを更新します。	拡張子	GA
az grafana list	Azure Managed Grafana インスタンスを一覧表示します。	拡張子	GA
az grafana notification-channel	インスタンスの通知チャネルを管理するコマンド。	拡張子	GA
az grafana notification-channel create	通知チャネルを作成します。	拡張子	GA
az grafana notification-channel delete	通知チャネルを削除します。	拡張子	GA
az grafana notification-channel list	インスタンスのすべての通知チャネルを一覧表示します。	拡張子	GA
az grafana notification-channel show	通知チャネルの詳細を取得します。	拡張子	GA
az grafana notification-channel test	通知チャネルをテストします。	拡張子	GA
az grafana notification-channel update	通知チャネルを更新します。	拡張子	GA
az grafana restore	アーカイブから Azure Managed Grafana インスタンスを復元します。	拡張子	プレビュー
az grafana service-account	サービス アカウントを管理するコマンド。	拡張子	GA
az grafana service-account create	新しいサービス アカウントを作成します。	拡張子	GA
az grafana service-account delete	サービス アカウントを削除します。	拡張子	GA
az grafana service-account list	既存のサービス アカウントを一覧表示します。	拡張子	GA
az grafana service-account show	サービス アカウントの詳細を取得します。	拡張子	GA
az grafana service-account token	サービス アカウント トークンを管理するコマンド。	拡張子	GA
az grafana service-account token create	新しいサービス アカウント トークンを作成します。	拡張子	GA
az grafana service-account token delete	サービス アカウント トークンを削除します。	拡張子	GA
az grafana service-account token list	既存のサービス アカウント トークンを一覧表示します。	拡張子	GA
az grafana service-account update	サービス アカウントを更新します。	拡張子	GA
az grafana show	Azure Managed Grafana インスタンスの詳細を表示します。	拡張子	GA
az grafana update	Azure Managed Grafana インスタンスを更新します。	拡張子	GA
az grafana user	インスタンスのユーザーを管理するコマンド。	拡張子	GA
az grafana user actual-user	現在のユーザーの詳細を取得します。	拡張子	GA
az grafana user list	ユーザーを一覧表示します。	拡張子	GA
az grafana user show	ユーザーの詳細を取得します。	拡張子	GA

az grafana backup

プレビュー

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

Azure Managed Grafana インスタンスのコンテンツをアーカイブにバックアップします。

az grafana backup --name
                  [--components {annotations, dashboards, datasources, folders, snapshots}]
                  [--directory]
                  [--folders-to-exclude]
                  [--folders-to-include]
                  [--resource-group]

例

2 つのフォルダーの下にあるバックアップ ダッシュボード (別のワークスペースにダッシュボードを復元するときに名前の再マッピングを有効にするためにデータ ソースが含まれています)

az grafana backup -g MyResourceGroup -n MyGrafana -d c:\temp --folders-to-include "Prod" "Compute Gateway" --components datasources dashboards folders

ダッシュボードをバックアップし、いくつかのフォルダーをスキップする

az grafana backup -g MyResourceGroup -n MyGrafana -d c:\temp  --folders-to-exclude General "Azure Monitor" --components datasources dashboards folders

必須のパラメーター

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--components -c

バックアップする Grafana アーティファクトの種類。

承認された値: annotations, dashboards, datasources, folders, snapshots

--directory -d

Grafana アーティファクトをバックアップするディレクトリ。

--folders-to-exclude -e

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

--folders-to-include -i

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

--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 create

Azure Managed Grafana インスタンスを作成します。

az grafana create --name
                  --resource-group
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--location]
                  [--principal-ids]
                  [--principal-types {Group, ServicePrincipal, User}]
                  [--skip-role-assignments {false, true}]
                  [--skip-system-assigned-identity {false, true}]
                  [--tags]
                  [--zone-redundancy {Disabled, Enabled}]

必須のパラメーター

--name -n

Azure Managed Grafana の名前。

--resource-group -g

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

省略可能のパラメーター

--deterministic-outbound-ip -i

有効にした場合、Grafana ワークスペースには、データソースのファイアウォールで使用できる固定エグレス IP が含まれます。 既定: 無効です。

承認された値: Disabled, Enabled

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--principal-ids

Grafana 管理として作成されるユーザー、グループなどの領域で区切られた Azure AD オブジェクト ID。 指定すると、CLI は現在ログインしているユーザーを Grafana 管理にしません。

--principal-types

--principal-ids とペアにする、スペースで区切られた Azure AD プリンシパルの種類。

承認された値: Group, ServicePrincipal, User

--skip-role-assignments

マネージド ID と現在のログイン ユーザーのロールの割り当てを作成しないでください。

承認された値: false, true

既定値: False

--skip-system-assigned-identity -s

システム割り当て ID は有効にしないでください。

承認された値: false, true

既定値: False

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--zone-redundancy

ゾーン冗長を有効にする必要があるかどうかを示します。 既定: 無効です。

承認された値: Disabled, Enabled

グローバル パラメーター

--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 delete

Azure Managed Grafana インスタンスを削除します。

az grafana delete --name
                  [--resource-group]
                  [--yes]

必須のパラメーター

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--resource-group -g

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

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--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 list

Azure Managed Grafana インスタンスを一覧表示します。

az grafana list [--resource-group]

省略可能のパラメーター

--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 restore

プレビュー

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

アーカイブから Azure Managed Grafana インスタンスを復元します。

az grafana restore --archive-file
                   --name
                   [--components {annotations, dashboards, datasources, folders, snapshots}]
                   [--remap-data-sources {false, true}]
                   [--resource-group]

例

ダッシュボードを復元します。 フォルダーの下にある場合は、コンポーネントの一覧に "folders" を含めます。"--remap-data-sources" を使用するため、CLI は、ターゲット ワークスペースで同じデータ ソースを指すダッシュボードを更新します

az grafana restore -g MyResourceGroup -n MyGrafana --archive-file backup\dashboards\ServiceHealth-202307051036.tar.gz --components dashboards folders --remap-data-sources

必須のパラメーター

--archive-file -a

Grafana アーティファクトの復元元のアーカイブ。

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--components -c

バックアップする Grafana アーティファクトの種類。

承認された値: annotations, dashboards, datasources, folders, snapshots

--remap-data-sources -r

復元中に、名前の一致を使用して、移行先ワークスペースで定義されたデータ ソースを参照するようにダッシュボードを更新します。

承認された値: 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 show

Azure Managed Grafana インスタンスの詳細を表示します。

az grafana show --name
                [--resource-group]

必須のパラメーター

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--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 update

Azure Managed Grafana インスタンスを更新します。

az grafana update --name
                  [--api-key {Disabled, Enabled}]
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--from-address]
                  [--from-name]
                  [--host]
                  [--major-version]
                  [--password]
                  [--public-network-access {Disabled, Enabled}]
                  [--resource-group]
                  [--skip-verify {false, true}]
                  [--smtp {Disabled, Enabled}]
                  [--start-tls-policy {MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS}]
                  [--tags]
                  [--user]

例

パブリック ネットワーク アクセスを無効にする

az grafana update -g MyResourceGroup -n MyGrafana --public-network-access disabled

mailgun の SMTP リレー サービスを介してメール通知を有効にする

az grafana update -g MyResourceGroup -n MyGrafana --smtp enabled --from-address johndoe@outlook.com --from-name john --host "smtp.mailgun.org:587" --user "postmaster@sandbox12345.mailgun.org" --password "password" --start-tls-policy OpportunisticStartTLS --skip-verify true

必須のパラメーター

--name -n

Azure Managed Grafana の名前。

省略可能のパラメーター

--api-key --service-account

有効にすると、Grafana API キーとサービス アカウントを構成できます。

承認された値: Disabled, Enabled

--deterministic-outbound-ip -i

有効にした場合、Grafana ワークスペースには、データソースのファイアウォールで使用できる固定エグレス IP が含まれます。

承認された値: Disabled, Enabled

--from-address

メールを送信するときに使用されるアドレス。

--from-name

メールを送信するときに使用する名前。

--host

SMTP サーバー URL (ポートが含まれています)。

--major-version

Grafana メジャー バージョン番号。

--password

SMTP サーバーのユーザー パスワード。

--public-network-access -p

パブリック ネットワーク アクセスを許可します。

承認された値: Disabled, Enabled

--resource-group -g

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

--skip-verify

SMTP サーバーの SSL の検証をスキップします。

承認された値: false, true

--smtp

Grafana に電子メールの送信を許可します。

承認された値: Disabled, Enabled

--start-tls-policy

TLS ポリシー。

承認された値: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--user

SMTP サーバーのユーザー名。

グローバル パラメーター

--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 を使います。