クイック スタート:Azure CLI を使用して Resource Graph 共有クエリを作成する
Azure CLI で Azure Resource Graph を使用する最初の手順は、拡張機能がインストールされていることを確認することです。 このクイック スタートでは、Azure CLI のインストールに拡張機能を追加するプロセスについて説明します。 ローカルにインストールされている Azure CLI または Azure Cloud Shell により拡張機能を使用することができます。
このプロセスの最後では、選択した Azure CLI のインストールに拡張機能を追加し、Resource Graph 共有クエリを作成します。
前提条件
Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。
Resource Graph 拡張機能を追加する
Azure CLI を Azure Resource Graph と連動させるには、拡張機能を追加する必要があります。 Windows 10上の bash、 Cloud Shell (スタンドアロンと内部の両方のポータル)、 Azure CLI Docker 画像、または、ローカルにインストールされた場合を含め、この拡張機能はAzure CLI を使用できる場合はいつでも動作します。
最新の Azure CLI がインストールされていることを確認します (2.8.0 以降)。 インストールされていない場合は、こちらの手順に従ってください。
選択した Azure CLI 環境で az extension add を使用し、次のコマンドで Resource Graph 拡張機能をインポートします。
# Add the Resource Graph extension to the Azure CLI environment az extension add --name resource-graph拡張機能がインストールされていて、必要なバージョン (1.1.0 以降) であることを az extension list で検証します。
# Check the extension list (note that you may have other extensions installed) az extension list # Run help for graph query options az graph query -h
Resource Graph 共有クエリを作成する
選択した環境に Azure CLI 拡張機能が追加されたので、今度は Resource Graph 共有クエリです。 共有クエリは、Azure Resource Graph エクスプローラーで権限を与えたり、実行したりできる Azure Resource Manager オブジェクトです。 このクエリでは、すべてのリソースの総数が "場所" 別にグループ化され、まとめられます。
Azure Resource Graph 共有クエリを格納するリソース グループを az group create で作成します。 このリソース グループの名前は
resource-graph-queriesであり、場所はwestus2です。# Login first with az login if not using Cloud Shell # Create the resource group az group create --name 'resource-graph-queries' --location 'westus2'graph拡張機能と az graph shared-query create コマンドを使用し、Azure Resource Graph 共有クエリを作成します。# Create the Azure Resource Graph shared query az graph shared-query create --name 'Summarize resources by location' \ --description 'This shared query summarizes resources by location for a pinnable map graphic.' \ --graph-query 'Resources | summarize count() by location' \ --resource-group 'resource-graph-queries'新しいリソース グループの共有クエリを一覧表示します。 az graph shared-query list コマンドによって値の配列が返されます。
# List all the Azure Resource Graph shared queries in a resource group az graph shared-query list --resource-group 'resource-graph-queries'共有クエリの結果を 1 つだけ取得するには、az graph shared-query show コマンドを使用します。
# Show a specific Azure Resource Graph shared query az graph shared-query show --resource-group 'resource-graph-queries' \ --name 'Summarize resources by location'Azure CLI の az graph query コマンド内で
{{shared-query-uri}}構文を利用し、共有クエリを実行します。 まず、前のshowコマンドの結果からidフィールドをコピーします。 例のshared-query-uriテキストをidフィールドからの値で置換しますが、前後の{{文字と}}文字はそのままにします。# Run a Azure Resource Graph shared query az graph query --graph-query "{{shared-query-uri}}"Note
{{shared-query-uri}}構文はプレビュー機能です。
Resource Graph 共有クエリを見つけるもう 1 つの方法は Azure portal を利用することです。 ポータルで検索バーを使用し、"Resource Graph のクエリ" を検索します。 共有クエリを選択します。 [概要] ページの [クエリ] タブに保存済みのクエリが表示されます。 [編集] ボタンをクリックすると、[Resource Graph エクスプローラー] でそれが開きます。
リソースをクリーンアップする
Resource Graph の共有クエリ、リソース グループ、拡張機能を Azure CLI 環境から削除する場合、次のコマンドを使用してそれを行うことができます。
# Delete the Azure Resource Graph shared query
az graph shared-query delete --resource-group 'resource-graph-queries' \
--name 'Summarize resources by location'
# Remove the resource group
# WARNING: This command deletes ALL resources you've added to this resource group without prompting for confirmation
az group delete --resource-group 'resource-graph-queries' --yes
# Remove the Azure Resource Graph extension from the Azure CLI environment
az extension remove -n resource-graph
次のステップ
このクイックスタートでは、Azure CLI 環境に Resource Graph 拡張機能を追加し、共有クエリを作成しました。 Resource Graph 言語の詳細については、クエリ言語の詳細ページに進んでください。