az graph

Note

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

Azure Resource Manager によって管理されているリソースに対してクエリを実行します。

詳細なヘルプについては、'az graph query --help' を実行します。

コマンド

名前	説明	型	Status
az graph query	Azure Resource Manager によって管理されているリソースに対してクエリを実行します。	拡張	GA
az graph shared-query	Azure リソース グラフの共有クエリを管理します。	拡張	Experimental
az graph shared-query create	共有クエリを作成します。	拡張	Experimental
az graph shared-query delete	共有クエリを削除します。	拡張	Experimental
az graph shared-query list	リソース グループ内のすべての共有クエリを一覧表示します。	拡張	Experimental
az graph shared-query show	共有クエリのプロパティを表示します。	拡張	Experimental

az graph query

Azure Resource Manager によって管理されているリソースに対してクエリを実行します。

クエリ言語と参照例の詳細については、こちらを参照 https://aka.ms/AzureResourceGraph-QueryLanguage してください。

az graph query --graph-query
               [--allow-partial-scopes {false, true}]
               [--first]
               [--management-groups]
               [--skip]
               [--skip-token]
               [--subscriptions]

例

リソース フィールドのサブセットを要求するリソースに対してクエリを実行します。

az graph query -q "project id, name, type, location, tags"

フィールドの選択、フィルター処理、集計を使用してリソースにクエリを実行します。

az graph query -q "project id, type, location | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by location | top 3 by count_"

結果のサブセットを要求し、20 個の項目をスキップし、次の 10 個を取得します。

az graph query -q "where type =~ "Microsoft.Compute" | project name, tags" --first 10 --skip 20

クエリするサブスクリプションを選択します。

az graph query -q "where type =~ "Microsoft.Compute" | project name, tags" --subscriptions 11111111-1111-1111-1111-111111111111 22222222-2222-2222-2222-222222222222

クエリを実行する管理グループを選択します。

az graph query -q "where type =~ "Microsoft.Compute" | project name, tags" --management-groups aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb --allow-partial-scopes

スキップ トークンを使用してクエリを実行します。

az graph query -q "where type =~ "Microsoft.Compute" | project name, tags" --skip-token skip_token_value_from_previous_query_response

必須のパラメーター

--graph-query --q -q

実行する Resource Graph クエリ。

省略可能のパラメーター

--allow-partial-scopes -a

下のサブスクリプションの一部のみをサーバーで処理できる場合にクエリが成功するかどうかを示します。

承認された値: false, true

既定値: False

--first

返されるオブジェクトの最大数。 指定できる範囲: 1 ~ 1000。

--management-groups -m

クエリを実行する管理グループの一覧。

--skip

最初の N 個のオブジェクトを無視し、再メインオブジェクトを取得します。

--skip-token

トークンをスキップして、該当する場合はクエリの次のページを取得します。

--subscriptions -s

クエリを実行するサブスクリプションの一覧。 既定では、アクセス可能なすべてのサブスクリプションに対してクエリが実行されます。

グローバル パラメーター

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