az grafana
Note
このリファレンスは、Azure CLI (バージョン 2.61.0 以降) の amg 拡張機能の一部です。 拡張機能は、 az grafana コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細を参照してください。
Azure Managed Grafana リソースを管理するためのコマンド。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
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 |
Grafana リソースのワークスペースを作成します。 この API はべき等であるため、ユーザーは新しい grafana を作成するか、既存の 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 |
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 |
指定したサブスクリプションの下にある Grafana のワークスペースのすべてのリソースを一覧表示します。 |
拡張子 | GA |
az grafana list-available-plugin |
使用可能なすべてのプラグインを一覧表示します。 |
拡張子 | GA |
az grafana migrate |
既存の Grafana インスタンスを Azure Managed Grafana インスタンスに移行します。 |
拡張子 | プレビュー |
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 |
Grafana リソースの特定のワークスペースのプロパティを取得します。 |
拡張子 | GA |
az grafana update |
Grafana リソースのワークスペースを更新します。 |
拡張子 | GA |
az grafana user |
インスタンスのユーザーを管理するコマンド。 |
拡張子 | GA |
az grafana user actual-user |
現在のユーザーの詳細を取得します。 |
拡張子 | GA |
az grafana user list |
ユーザーを一覧表示します。 |
拡張子 | GA |
az grafana user show |
ユーザーの詳細を取得します。 |
拡張子 | GA |
az grafana wait |
条件が満たされるまで CLI を待機状態にします。 |
拡張子 | 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
必須のパラメーター
Azure Managed Grafana の名前。
省略可能のパラメーター
バックアップする Grafana アーティファクトの種類。
Grafana アーティファクトをバックアップするディレクトリ。
バックアップまたは同期で除外するフォルダー。
バックアップまたは同期に含めるフォルダー。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az grafana create
Grafana リソースのワークスペースを作成します。 この API はべき等であるため、ユーザーは新しい grafana を作成するか、既存の grafana を更新できます。
az grafana create --name
--resource-group
[--api-key {Disabled, Enabled}]
[--deterministic-outbound-ip {Disabled, Enabled}]
[--grafana-major-version]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--principal-ids]
[--public-network-access {Disabled, Enabled}]
[--skip-identity {0, 1, f, false, n, no, t, true, y, yes}]
[--skip-role-assignments {0, 1, f, false, n, no, t, true, y, yes}]
[--sku-tier]
[--tags]
[--zone-redundancy {Disabled, Enabled}]
例
Standard SKU とパブリック ネットワーク アクセスを有効にして Azure Managed Grafana リソースを作成する
az grafana create --resource-group myResourceGroup --workspace-name myWorkspace --sku-tier Standard --public-network-access Enabled
必須のパラメーター
Azure Managed Grafana のワークスペース名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
Grafana インスタンスの API キー設定。
Grafana インスタンスが決定論的送信 IP を使用するかどうか。
ターゲットとなる主要な Grafana ソフトウェア バージョン。
grafana リソースが存在する地理的な場所。
実行時間の長い操作の終了を待機しません。
Grafana 管理者として作成されるユーザー、グループなどの領域で区切られた Azure AD オブジェクト ID。 指定すると、CLI では、現在ログインしているユーザーが Grafana Admin Support の短縮構文、json-file、yaml-file として作成されることはありません。 詳細を表示するには、"??" を試してください。
パブリック インターフェイス経由でトラフィックを有効または無効にする状態を示します。
システム割り当て ID は有効にしないでください。 ID を自分で管理する場合は、このオプションを使用します。
Grafana インスタンスと現在の CLI アカウントのマネージド ID に対する既定のロール割り当ての作成をスキップします。 ロールの割り当てを自分で管理する場合は、このオプションを使用します。
grafana リソースの SKU。
grafana リソースのタグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
Grafana インスタンスのゾーン冗長設定。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az grafana delete
Grafana リソースのワークスペースを削除します。
az grafana delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
Azure Managed Grafana のワークスペース名。
実行時間の長い操作の終了を待機しません。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
確認のダイアログを表示しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az grafana list
指定したサブスクリプションの下にある Grafana のワークスペースのすべてのリソースを一覧表示します。
az grafana list [--max-items]
[--next-token]
[--resource-group]
省略可能のパラメーター
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token
トークン値を指定します。
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az grafana list-available-plugin
使用可能なすべてのプラグインを一覧表示します。
az grafana list-available-plugin [--ids]
[--name]
[--resource-group]
[--subscription]
省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
Azure Managed Grafana のワークスペース名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az grafana migrate
このコマンドはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
既存の Grafana インスタンスを Azure Managed Grafana インスタンスに移行します。
az grafana migrate --name
--src-endpoint
--src-token-or-key
[--dry-run {false, true}]
[--folders-to-exclude]
[--folders-to-include]
[--overwrite {false, true}]
[--resource-group]
例
ダッシュボードとフォルダーをローカルの Grafana インスタンスから Azure Managed Grafana インスタンスに移行します。
az grafana migrate -g MyResourceGroup -n MyGrafana -s http://localhost:3000 -t YourServiceTokenOrAPIKey
必須のパラメーター
Azure Managed Grafana の名前。
移行元の Grafana インスタンス エンドポイント。
移行元のアクセス権を取得する Grafana インスタンス サービス トークン (または API キー)。
省略可能のパラメーター
コミットせずに変更をプレビューします。 上書きよりも優先されます。
バックアップまたは同期で除外するフォルダー。
バックアップまたは同期に含めるフォルダー。
以前のダッシュボード、ライブラリ パネル、およびフォルダーを同じ uid またはタイトルで上書きします。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --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
必須のパラメーター
Grafana アーティファクトの復元元のアーカイブ。
Azure Managed Grafana の名前。
省略可能のパラメーター
バックアップする Grafana アーティファクトの種類。
復元中に、名前の一致を使用して、移行先ワークスペースで定義されたデータ ソースを参照するようにダッシュボードを更新します。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az grafana show
Grafana リソースの特定のワークスペースのプロパティを取得します。
az grafana show [--ids]
[--name]
[--resource-group]
[--subscription]
省略可能のパラメーター
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
Azure Managed Grafana のワークスペース名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az grafana update
Grafana リソースのワークスペースを更新します。
az grafana update [--api-key {Disabled, Enabled}]
[--deterministic-outbound-ip {Disabled, Enabled}]
[--from-address]
[--from-name]
[--grafana-major-version]
[--host]
[--ids]
[--name]
[--password]
[--public-network-access {Disabled, Enabled}]
[--resource-group]
[--skip-verify {0, 1, f, false, n, no, t, true, y, yes}]
[--sku-tier]
[--smtp {0, 1, f, false, n, no, t, true, y, yes}]
[--start-tls-policy {MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS}]
[--subscription]
[--tags]
[--user]
[--zone-redundancy {Disabled, Enabled}]
例
パブリック ネットワーク アクセスを無効にする
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
省略可能のパラメーター
Grafana インスタンスの API キー設定。
Grafana インスタンスが決定論的送信 IP を使用するかどうか。
https://pkg.go.dev/net/mail#Addressメールを送信するときに使用されるアドレス。
メールを送信するときに使用する名前。 既定値は "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Addressです。
ターゲットとなる主要な Grafana ソフトウェア バージョン。
ポートを持つ SMTP サーバーのホスト名 (例: test.email.net:587)。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
Azure Managed Grafana のワークスペース名。
SMTP 認証のパスワード。パスワードに # または ;が含まれている場合は、三重引用符で囲む必要があります。
パブリック インターフェイス経由でトラフィックを有効または無効にする状態を示します。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
SMTP サーバーの SSL を確認します。 既定値は false https://pkg.go.dev/crypto/tls#Configです。
grafana リソースの SKU。
これを有効にして、Grafana が電子メールを送信できるようにします。
SMTP 構成 https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicyの StartTLSPolicy 設定。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
grafana リソースのタグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
SMTP 認証のユーザー。
Grafana インスタンスのゾーン冗長設定。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az grafana wait
条件が満たされるまで CLI を待機状態にします。
az grafana wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
省略可能のパラメーター
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
削除されるまで待ちます。
リソースが存在するまで待ちます。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
ポーリング間隔 (秒単位)。
Azure Managed Grafana のワークスペース名。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
最大待機時間 (秒単位)。
provisioningState が 'Succeeded' で更新されるまで待ちます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI