クイック スタート: Azure CLI を使用して Resource Graph クエリを実行する

  • [アーティクル]

このクイックスタートでは、Azure CLI の拡張機能を使用して Azure Resource Graph クエリを実行する方法について説明します。 この記事では、クエリの結果を順序付け (並べ替え) て制限する方法についても説明します。 テナント、管理グループ、またはサブスクリプション内のリソースのクエリを実行できます。 完了したら、拡張機能を削除できます。

前提条件

  • Azure アカウントをお持ちでない場合は、開始する前に無料アカウントを作成してください。
  • Azure CLI は、Resource Graph 拡張機能のバージョン 2.22.0 以降である必要があります。
  • Visual Studio Code。

Azure に接続する

Visual Studio Code ターミナル セッションから Azure に接続します。 複数のサブスクリプションがある場合は、コマンドを実行してコンテキストをサブスクリプションに設定します。 <subscriptionID> は、Azure サブスクリプション ID に置き換えてください。

az login

# Run these commands if you have multiple subscriptions
az account list --output table
az account set --subscription <subscriptionID>

拡張機能をインストールする

Azure CLI で Azure Resource Graph を使用してリソースのクエリを実行できるようにするには、Resource Graph 拡張機能をインストールする必要があります。 拡張機能は、次の手順で手動でインストールできます。 それ以外の場合は、az graph で初めてクエリを実行すると、拡張機能をインストールするように求められます。

  1. 使用可能な拡張機能とバージョンを一覧表示します。

    az extension list-available --output table

  2. 拡張機能をインストールします。

    az extension add --name resource-graph

  3. 拡張機能がインストールされたことを確認します。

    az extension list --output table

  4. 拡張機能の構文を表示します。

    az graph query --help

    Azure CLI 拡張機能の詳細については、「Azure CLI で拡張機能を使用および管理する」を参照してください。

クエリの実行

Azure CLI 拡張機能が環境に追加されたら、テナントベースのクエリを実行できます。 この例のクエリでは、各リソースの name と type を含む 5 つの Azure リソースが返されます。 管理グループまたはサブスクリプションでクエリを実行するには、--management-groups または --subscriptions 引数を使用します。

  1. Azure Resource Graph クエリを実行します。

    az graph query --graph-query 'Resources | project name, type | limit 5'

    このクエリの例では、order by のような並べ替え修飾子は使用されていません。 このクエリを複数回実行すると、要求ごとに得られる一連のリソースが異なる可能性があります。

  2. このクエリを更新して name プロパティを order by します。

    az graph query --graph-query 'Resources | project name, type | limit 5 | order by name asc'

    前のクエリのように、このクエリを複数回実行すると、要求ごとに得られる一連のリソースが異なる可能性があります。 クエリ コマンドの順序が重要です。 この例では、limit の後に order by がきます。 このクエリでは、結果が 5 つのリソースに制限され、これらが名前で順序付けられます。

  3. このクエリを更新して、name プロパティを order by してから、出力を 5 件の結果に limit します。

    az graph query --graph-query 'Resources | project name, type | order by name asc | limit 5'

    環境が変更されない状態でこのクエリを複数回実行した場合、結果は変わらず、name プロパティで並べ替えられますが、引き続き 5 件の結果に制限されます。 このクエリでは、結果が名前で順序付けられ、出力が 5 件のリリースに制限されます。

リソースをクリーンアップする

Resource Graph 拡張機能を削除するには、次のコマンドを実行します。

az extension remove --name resource-graph

Azure CLI セッションからサインアウトするには:

az logout

次のステップ

このクイックスタートでは、Azure CLI の拡張機能を使用して Azure Resource Graph クエリを実行しました。 詳細については、クエリ言語の詳細に関する記事を参照してください。

Azure Resource Graph クエリ言語の概要