Краткое руководство. Создание общего запроса к Resource Graph с помощью Azure CLI

  • Статья

При использовании Azure Resource Graph с Azure CLI в первую очередь необходимо проверить, установлено ли соответствующее расширение. В этом кратком руководстве описывается процесс добавления расширения к установке Azure CLI. Можно использовать расширение Azure CLI, установленное локально или через Azure Cloud Shell.

Выполнив этот процесс, вы добавите расширение к выбранной установке Azure CLI и создадите общий запрос по Resource Graph.

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

Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.

Добавление расширения "Граф ресурсов"

Чтобы обеспечить работу Azure CLI с Azure Resource Graph, необходимо добавить расширение. Это расширение работает везде, где может использоваться оболочка Azure CLI, включая bash на операционной системе Windows 10, Cloud Shell (как автономно, так и внутри портала), образ Azure CLI Docker или установленную локально.

  1. Убедитесь, что установлена последняя версия Azure CLI (не ниже 2.8.0). Если она еще не установлена, выполните эти инструкции.

  2. В своей среде Azure CLI выполните команду az extension add, чтобы импортировать расширение Resource Graph с помощью следующей команды:

    # Add the Resource Graph extension to the Azure CLI environment
az extension add --name resource-graph

  3. Убедитесь, что расширение установлено и имеет подходящий номер версии (не ниже 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 Manager, которому можно предоставить разрешения на доступ к обозревателю Azure Resource Graph или на выполнение в нем. Этот запрос вычисляет общее количество ресурсов с группировкой по расположению.

  1. Создайте группу ресурсов с помощью команды az group create, чтобы сохранить общий запрос к Azure Resource Graph. Эта группа ресурсов имеет имя 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'

  2. Создайте общий запрос к Azure Resource Graph с помощью расширения graph и команды az graph shared-query create.

    # 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'

  3. Получите список общих запросов в новой группе ресурсов. Команда 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'

  4. Чтобы получить в качестве результата только один общий запрос, используйте команду 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'

  5. Выполните общий запрос в Azure CLI, используя синтаксис {{shared-query-uri}} в команде az graph query. Для начала скопируйте поле id из результата выполнения предыдущей команды show. Замените в этом примере текст shared-query-uri значением из поля id, но сохраните обрамляющие его символы {{ и }}.

    # Run a Azure Resource Graph shared query
az graph query --graph-query "{{shared-query-uri}}"

    Примечание

    Синтаксис {{shared-query-uri}} находится в режиме предварительной версии функции.

Также вы можете найти общие запросы к Resource Graph на портале Azure. В строке поиска на портале введите строку "запросы к 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

Дальнейшие действия

При работе с этим кратким руководством вы добавили расширение Resource Graph в среду Azure CLI и создали общий запрос. Чтобы узнать больше о языке Resource Graph, перейдите на страницу сведений о языке запросов.

Получите более подробную информацию о языке запросов.