次の方法で共有

az portal dashboard

  • リファレンス

注

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

ポータル ダッシュボードを管理します。

コマンド

名前 説明 型 状態
az portal dashboard create

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

 拡張 GA
az portal dashboard delete

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

 拡張 GA
az portal dashboard import

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

 拡張 GA
az portal dashboard list

サブスクリプションまたはリソース グループ内のすべてのダッシュボードを一覧表示します。

 拡張 GA
az portal dashboard show

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

 拡張 GA
az portal dashboard update

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

 拡張 GA

az portal dashboard create

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

az portal dashboard create --name
                           --resource-group
                           [--input-path]
                           [--lenses]
                           [--___location]
                           [--metadata]
                           [--tags]

例

ダッシュボードを作成する

az portal dashboard create --___location "eastus" --name "testDashboard" --resource-group "testRG" --input-path "/src/json/properties.json" --tags aKey=aValue anotherKey=anotherValue

必須のパラメーター

--name -n

ダッシュボードの名前。

--resource-group -g

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

省略可能のパラメーター

--input-path

ダッシュボード プロパティの JSON ファイルへのパス。 指定した場合は、他の Properties 引数を指定しないでください。

--lenses

ダッシュボードレンズ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--___location -l

リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。

--metadata

ダッシュボードのメタデータ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター
--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 portal dashboard delete

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

az portal dashboard delete [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--yes]

例

ダッシュボードを削除する

az portal dashboard delete --name testDashboard --resource-group testRG

省略可能のパラメーター

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

ダッシュボードの名前。

--resource-group -g

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

--subscription

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

--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 portal dashboard import

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

az portal dashboard import --input-path
                           --name
                           --resource-group

例

ダッシュボードのインポート

az portal dashboard import -n myDashboard -g myResourceGroup --input-path /src/json/dashboard.json

必須のパラメーター

--input-path

ダッシュボード JSON ファイルへのパス。

--name -n

ダッシュボードの名前。

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

サブスクリプションまたはリソース グループ内のすべてのダッシュボードを一覧表示します。

az portal dashboard list [--max-items]
                         [--next-token]
                         [--resource-group]

例

resourceGroup 内のすべてのダッシュボードを一覧表示する

az portal dashboard list --resource-group testRG

サブスクリプション内のすべてのダッシュボードを一覧表示する

az portal dashboard list

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

--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 portal dashboard show

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

az portal dashboard show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

例

ダッシュボードを取得する

az portal dashboard show --name testDashboard --resource-group testRG

省略可能のパラメーター

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

ダッシュボードの名前。

--resource-group -g

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

--subscription

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

グローバル パラメーター
--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 portal dashboard update

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

az portal dashboard update [--add]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--input-path]
                           [--lenses]
                           [--metadata]
                           [--name]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--subscription]
                           [--tags]

例

ダッシュボードを更新する

az portal dashboard update --name "testDashboard" --resource-group "testRG" --input-path "/src/json/properties.json"

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--input-path

ダッシュボード プロパティの JSON ファイルへのパス。 指定した場合は、他の Properties 引数を指定しないでください。

--lenses

ダッシュボードレンズ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--metadata

ダッシュボードのメタデータ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--name -n

ダッシュボードの名前。

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

--resource-group -g

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

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

--subscription

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

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター
--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 を使用します。