Краткое руководство. Выполните первый запрос графа ресурсов с помощью Azure CLIQuickstart: Run your first Resource Graph query using Azure CLI

При использовании Azure Resource Graph в первую очередь необходимо проверить, установлено ли расширение для Azure CLI.The first step to using Azure Resource Graph is to check that the extension for Azure CLI is installed. В этом кратком руководстве описывается процесс добавления расширения к установке Azure CLI.This quickstart walks you through the process of adding the extension to your Azure CLI installation. Можно использовать расширение Azure CLI, установленное локально или через Azure Cloud Shell.You can use the extension with Azure CLI installed locally or through the Azure Cloud Shell.

В конце этого процесса будет добавлено расширение к установке Azure CLI по выбору и выполнен первого запрос графа ресурсов.At the end of this process, you'll have added the extension to your Azure CLI installation of choice and run your first Resource Graph query.

Предварительные требованияPrerequisites

Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.If you don't have an Azure subscription, create a free account before you begin.

Использование Azure Cloud ShellUse Azure Cloud Shell

В Azure есть Azure Cloud Shell, интерактивная оболочка среды, с которой можно работать в браузере.Azure hosts Azure Cloud Shell, an interactive shell environment that you can use through your browser. Для работы со службами Azure можно использовать Bash или PowerShell с Cloud Shell.You can use either Bash or PowerShell with Cloud Shell to work with Azure services. Для запуска кода из этой статьи можно использовать предварительно установленные команды Cloud Shell. Ничего дополнительного в локальной среде устанавливать не нужно.You can use the Cloud Shell preinstalled commands to run the code in this article without having to install anything on your local environment.

Начало работы с Azure Cloud ShellTo start Azure Cloud Shell:

ПараметрOption Пример и ссылкаExample/Link
Нажмите кнопку Попробовать в правом верхнем углу блока с кодом.Select Try It in the upper-right corner of a code block. При нажатии кнопки Попробовать код не копируется в Cloud Shell автоматически.Selecting Try It doesn't automatically copy the code to Cloud Shell. Открытие Azure Cloud Shell с помощью кнопки "Попробовать"
Перейдите по адресу https://shell.azure.com или нажмите кнопку Запуск Cloud Shell, чтобы открыть Cloud Shell в браузере.Go to https://shell.azure.com, or select the Launch Cloud Shell button to open Cloud Shell in your browser. Запуск Cloud Shell в новом окнеLaunch Cloud Shell in a new window
На портале Azure в правом верхнем углу в строке меню нажмите кнопку Cloud Shell.Select the Cloud Shell button on the top-right menu bar in the Azure portal. Кнопка "Cloud Shell" на портале Azure

Чтобы выполнить код из этой статьи в Azure Cloud Shell, выполните следующие действия:To run the code in this article in Azure Cloud Shell:

  1. Запустите Cloud Shell.Start Cloud Shell.

  2. В блоке кода нажмите кнопку Копировать, чтобы скопировать код.Select the Copy button on a code block to copy the code.

  3. Вставьте код в окно сеанса Cloud Shell, нажав клавиши CTRL+SHIFT+V в Windows и Linux или CMD+SHIFT+V в macOS.Paste the code into the Cloud Shell session by selecting Ctrl+Shift+V on Windows and Linux or by selecting Cmd+Shift+V on macOS.

  4. Нажмите клавишу ВВОД, чтобы выполнить код.Select Enter to run the code.

Добавление расширения "Граф ресурсов"Add the Resource Graph extension

Чтобы позволить Azure CLI выполнять запрос графических ресурсов Azure, необходимо добавить расширение.To enable Azure CLI to query Azure Resource Graph, the extension must be added. Это расширение работает везде, где может использоваться оболочка Azure CLI, включая bash на операционной системе Windows 10, Cloud Shell (как автономно, так и внутри портала), образ Azure CLI Docker или установленную локально.This extension works wherever Azure CLI can be used, including bash on Windows 10, Cloud Shell (both standalone and inside the portal), the Azure CLI Docker image, or locally installed.

  1. Убедитесь, что установлена последняя версия Azure CLI (не ниже 2.0.76).Check that the latest Azure CLI is installed (at least 2.0.76). Если она еще не установлена, выполните эти инструкции.If it isn't yet installed, follow these instructions.

  2. В выбранной вами среде Azure CLI импортируйте ее с помощью следующей команды:In your Azure CLI environment of choice, import it with the following command:

    # Add the Resource Graph extension to the Azure CLI environment
    az extension add --name resource-graph
    
  3. Проверьте установку расширения и номер версии (по крайней мере 1.0.0):Validate that the extension has been installed and is the expected version (at least 1.0.0):

    # 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
    

Выполните первый запрос график ресурсовRun your first Resource Graph query

Теперь, когда расширение для Azure CLI добавлено в выбранную среду, попробуем выполнить простой запрос к Resource Graph.With the Azure CLI extension added to your environment of choice, it's time to try out a simple Resource Graph query. Запрос возвращает первые пять ресурсов Azure с Именем и Типом ресурса для каждого ресурса.The query will return the first five Azure resources with the Name and Resource Type of each resource.

  1. Запустите ваш первый запрос графа ресурсов Azure, используя graph расширение и query команду :Run your first Azure Resource Graph query using the graph extension and query command:

    # Login first with az login if not using Cloud Shell
    
    # Run Azure Resource Graph query
    az graph query -q 'Resources | project name, type | limit 5'
    

    Примечание

    Так как этот пример запроса не меняет сортировку, например order by, выполнение этого запроса несколько раз может получить различные наборы ресурсов для каждого запроса.As this query example does not provide a sort modifier such as order by, running this query multiple times is likely to yield a different set of resources per request.

  2. Обновите запрос свойством order by Имя:Update the query to order by the Name property:

    # Run Azure Resource Graph query with 'order by'
    az graph query -q 'Resources | project name, type | limit 5 | order by name asc'
    

    Примечание

    Как и с первым запросом, выполнение этого запроса несколько раз может получить различные наборы ресурсов для каждого запроса.Just as with the first query, running this query multiple times is likely to yield a different set of resources per request. Важен порядок команд запроса.The order of the query commands is important. В этом примере order by следует после limit.In this example, the order by comes after the limit. Это сначала ограничивает результаты запроса, а затем располагает их в нужном порядке.This will first limit the query results and then order them.

  3. Обновите запрос, чтобы сначала выполнить сортировку (order by) по свойству Имя, а затем ограничить (limit) вывод пятью первыми результатами:Update the query to first order by the Name property and then limit to the top five results:

    # Run Azure Resource Graph query with `order by` first, then with `limit`
    az graph query -q 'Resources | project name, type | order by name asc | limit 5'
    

Когда окончательный запрос выполняется несколько раз при условии, что ничего в вашей среде не изменяется, возвращаемые результаты будут последовательны и ожидаемы — упорядочены по свойству Имя и ограничены пятью первыми результатами.When the final query is run several times, assuming that nothing in your environment is changing, the results returned will be consistent and as expected -- ordered by the Name property, but still limited to the top five results.

Очистка ресурсовClean up resources

Если вы хотите удалить расширение "Граф ресурсов" из среды Azure CLI, это можно сделать с помощью следующей команды:If you wish to remove the Resource Graph extension from your Azure CLI environment, you can do so by using the following command:

# Remove the Resource Graph extension from the Azure CLI environment
az extension remove -n resource-graph

Дополнительная информацияNext steps

При работе с этим кратким руководством вы добавили расширение Resource Graph в среду Azure CLI и выполнили первый запрос.In this quickstart, you've added the Resource Graph extension to your Azure CLI environment and run your first query. Чтобы узнать больше о языке Resource Graph, перейдите на страницу сведений о языке запросов.To learn more about the Resource graph language, continue to the query language details page.