Quickstart: Run Resource Graph query using Azure portal

מאמר
04/23/2024

This quickstart describes how to run an Azure Resource Graph query in the Azure portal using Azure Resource Graph Explorer. Resource Graph Explorer allows you to query information about the Azure Resource Manager resource types and properties. Resource Graph Explorer also provides an interface for working with multiple queries, evaluating the results, and even converting the results of some queries into a chart that can be pinned to an Azure dashboard.

Prerequisites

If you don't have an Azure account, create a free account before you begin.

Run a query

Run a query from the Azure portal using Azure Resource Graph Explorer.

Sign in to the Azure portal.
Search for resource graph and select Resource Graph Explorer.
If you need to change the scope, select Directory. Then select the directory, management group, or subscription for the resources you want to query.
In the Query 1 portion of the window, copy and paste the following query. Then select Run query.
```
resources
| project name, type
| limit 5
```
This query example doesn't provide a sort modifier like order by. If you run the query multiple times, it might yield a different set of resources for each request.
Review the query response in the Results tab and select the Messages tab to see details about the query, including the count of results and duration of the query. Errors, if any, are displayed in Messages.
Update the query to order by the name property. Then, select Run query
```
resources
| project name, type
| limit 5
| order by name asc
```
Like the previous query, running this query multiple times might yield a different set of resources for each request. The order of the query commands is important. In this example, the order by comes after the limit. The query limits the results to five resources and then orders those results by name.
Update the query to order by the name property and then limit to the top five results. Then, select Run query.
```
resources
| project name, type
| order by name asc
| limit 5
```
If this query is run several times with no changes to your environment, the results are consistent and ordered by the name property, but still limited to five results. The query orders the results by name and then limits the output to five resources.

Schema browser

The schema browser is located in the left pane of Resource Graph Explorer. This list of resources shows all the resource types of Azure resources supported by Azure Resource Graph and that exist in your tenant. Select a resource type or property to show child properties that can be used to create a Resource Graph query.

Select a table name from the schema browser and it gets added to the query. When you select a resource type it gets added to the query, like where type =="<resource type>". If you select a property it gets added to the next line in the query, like where <propertyName> == "INSERT_VALUE_HERE". You can use the schema browser to find properties that you can use in queries. Be sure to replace INSERT_VALUE_HERE with your own value, and adjust the query with conditions, operators, and functions.

This example shows a query that was built from the schema browser by selecting the table authorizationresources with resource type microsoft.authorization/roledefinitions and the property roleName.

authorizationresources
| where type == "microsoft.authorization/roledefinitions"
| where properties['roleName'] == "INSERT_VALUE_HERE"

Download query results as a CSV file

To download comma-separated values (CSV) results from the Azure portal, browse to the Azure Resource Graph Explorer and run a query. On the toolbar, select Download as CSV as shown in the following screenshot:

When you use the Download as CSV export functionality of Azure Resource Graph Explorer, the result set is limited to 55,000 records. This limitation is a platform limit that can't be overridden by filing an Azure support ticket.

Create a chart from query results

You can create charts from queries that output a count for the number of resources. Queries that output lists can't be made into a chart. If you try to create a chart from a list, a message like the result set isn't compatible with a donut chart visualization is displayed in the Charts tab.

To create a chart from query results, do the following steps:

In the Query 1 portion of the window, enter the following query and select Run query.

resources
| where type == "microsoft.compute/virtualmachines"
| summarize count() by tostring(properties.storageProfile.osDisk.osType)

Select the Results tab and note that the response for this query provides counts.
Select the Charts tab. Change the type from Select chart type... to either Bar chart or Donut chart.

Pin query visualization to dashboard

When you have results from a query that can be visualized, that data visualization can be pinned to your Azure portal dashboard. After running the previous query, follow these steps:

Select Save and use the name Virtual machine by OS type and type as Private queries. Then select Save at the bottom of the right pane.
Select Run query to rerun the query you saved.
On the Charts tab, select a data visualization. Then select Pin to dashboard.
From Pin to Dashboard select the existing dashboard where you want the chart to appear.
Select Dashboard from the hamburger menu (three horizontal lines) on the top, left side of any portal page.

The query is now available on your dashboard with the title Virtual machine by OS type. If the query wasn't saved before it was pinned, the name is Query 1 instead.

The query and resulting data visualization run and update each time the dashboard loads, providing real time and dynamic insights to your Azure environment directly in your workflow.

Queries that result in a list can also be pinned to the dashboard. The feature isn't limited to data visualizations of queries.

When a query is run from the portal, you can select Directory to change the query's scope for the directory, management group, or subscription of the resources you want to query. When Pin to dashboard is selected, the results are added to your Azure dashboard with the scope used when the query was run.

For more information about working with dashboards, see Create a dashboard in the Azure portal.

Clean up resources

If you want to remove the sample Resource Graph dashboards from your Azure portal environment, do the following steps:

Select Dashboard from the hamburger menu (three horizontal lines) on the top, left side of any portal page.
On your dashboard, find the Virtual machine by OS type chart and select the ellipsis (...) to display the menu.
Select Remove from dashboard select Save to confirm.

If you want to delete saved queries, like Virtual machine by OS type, do the following steps:

Go to Azure Resource Graph Explorer.
Select Open a query.
Select Type Private queries.
From Query name select the rubbish bin icon to Delete this query.
Select Yes to confirm the deletion.

Next steps

In this quickstart, you used Azure Resource Graph Explorer to run a query and reviewed how to use charts and dashboards. To learn more, go to the query language details article.

Understanding the Azure Resource Graph query language

שתף באמצעות