Краткое руководство. Запуск первого запроса Resource Graph с помощью Azure PowerShell

При использовании Azure Resource Graph прежде всего необходимо убедиться, что модуль для Azure PowerShell установлен. В этом кратком руководстве описывается процесс добавления модуля к установке Azure PowerShell.

В конце этого процесса вы добавите модуль к установке Azure PowerShell на свой выбор и выполните первый запрос Resource Graph.

Необходимые компоненты

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

Azure Cloud Shell

В Azure есть Azure Cloud Shell, интерактивная оболочка среды, с которой можно работать в браузере. Для работы со службами Azure можно использовать Bash или PowerShell с Cloud Shell. Для запуска кода из этой статьи можно использовать предварительно установленные команды Cloud Shell. Ничего дополнительного в локальной среде устанавливать не нужно.

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

Вариант Пример и ссылка
Нажмите кнопку Попробовать в правом верхнем углу блока кода или команд. При нажатии кнопки Попробовать код или команда не копируется в Cloud Shell автоматически. Screenshot that shows an example of Try It for Azure Cloud Shell.
Чтобы открыть Cloud Shell в браузере, перейдите по адресу https://shell.azure.com или нажмите кнопку Запуск Cloud Shell. Button to launch Azure Cloud Shell.
Нажмите кнопку Cloud Shell в строке меню в правом верхнем углу окна портала Azure. Screenshot that shows the Cloud Shell button in the Azure portal

Чтобы использовать Azure Cloud Shell, выполните следующие действия:

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

  2. Нажмите кнопку Копировать в блоке кода (или блоке команд), чтобы скопировать код или команду.

  3. Вставьте код или команду в окно сеанса Cloud Shell, нажав клавиши CTRL+SHIFT+V в Windows и Linux или CMD+SHIFT+V в macOS.

  4. Нажмите клавишу ВВОД, чтобы запустить код или команду.

Добавить модуль "График ресурсов"

Чтобы разрешить Azure PowerShell выполнять запрос к Azure Resource Graph, необходимо добавить модуль . Этот модуль можно использовать с локально установленной средой PowerShell, с Azure Cloud Shell либо с образом Docker PowerShell.

Основные требования

Модуль Azure Resource Graph требует следующее программное обеспечение.

  • Azure PowerShell 1.0.0 или более поздней версии. Если она еще не установлена, выполните эти инструкции.

  • Модуль PowerShellGet 2.0.1 или более поздней версии. Если он еще не установлен или не обновлен, выполните эти инструкции.

Установка модуля

Модуль Resource Graph для PowerShell — Az.ResourceGraph.

  1. Запустите следующие команды из командной строки PowerShell с правами администратора.

    # Install the Resource Graph module from PowerShell Gallery
    Install-Module -Name Az.ResourceGraph
    
  2. Убедитесь, что импортирован модуль последней версии 0.11.0.

    # Get a list of commands for the imported Az.ResourceGraph module
    Get-Command -Module 'Az.ResourceGraph' -CommandType 'Cmdlet'
    

Выполните первый запрос график ресурсов

Теперь, когда модуль Azure PowerShell добавлен в выбранную среду, попробуем выполнить простой запрос Resource Graph на основе арендатора. Запрос возвращает первые пять ресурсов Azure с указанными значениями Имя и Тип ресурса для каждого ресурса. Чтобы выполнить запрос по группе управления или подписке, используйте параметры -ManagementGroup и -Subscription.

  1. Запустите ваш первый запрос графика ресурсов Azure, используя командлет Search-AzGraph:

    # Login first with Connect-AzAccount if not using Cloud Shell
    
    # Run Azure Resource Graph query
    Search-AzGraph -Query 'Resources | project name, type | limit 5'
    

    Примечание.

    Так как этот пример запроса не содержит модификатор сортировки, такой как order by, повторное выполнение запроса может каждый раз возвращать разные наборы ресурсов.

  2. Обновите запрос свойством order byИмя:

    # Run Azure Resource Graph query with 'order by'
    Search-AzGraph -Query 'Resources | project name, type | limit 5 | order by name asc'
    

    Примечание.

    Как и с первым запросом, выполнение этого запроса несколько раз может получить различные наборы ресурсов для каждого запроса. Важен порядок команд запроса. В этом примере order by следует после limit. Эта последовательность команд сначала ограничивает результаты запроса, а затем упорядочивает их.

  3. Обновите запрос, чтобы сначала выполнить сортировку (order by) по свойству Имя, а затем ограничить (limit) вывод пятью первыми результатами:

    # Store the query in a variable
    $query = 'Resources | project name, type | order by name asc | limit 5'
    
    # Run Azure Resource Graph query with `order by` first, then with `limit`
    Search-AzGraph -Query $query
    

Повторное выполнение последней версии запроса, если ничего не изменяется в самой среде, возвращает стабильные результаты, отсортированные по свойству Name и ограниченные пятью первыми результатами.

Примечание.

Если запрос не возвращает результаты из подписки, к которой у вас уже есть доступ, имейте ввиду, что командлет Search-AzGraph использует значения по умолчанию для подписок в контексте по умолчанию. Чтобы просмотреть список идентификаторов подписок, которые входят в контекст по умолчанию, выполните (Get-AzContext).Account.ExtendedProperties.Subscriptions. Если требуется выполнить поиск во всех подписках, к которым у вас есть доступ, можно задать PSDefaultParameterValues для командлета Search-AzGraph, выполнив команду $PSDefaultParameterValues=@{"Search-AzGraph:Subscription"= $(Get-AzSubscription).ID}.

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

Если вы хотите удалить модуль "График ресурсов" из среды Azure PowerShell, это можно сделать с помощью следующей команды:

# Remove the Resource Graph module from the current session
Remove-Module -Name 'Az.ResourceGraph'

# Uninstall the Resource Graph module from the environment
Uninstall-Module -Name 'Az.ResourceGraph'

Примечание.

Это не приводит к удалению скачанного ранее файла модуля. Он удаляется только из открытого сеанса PowerShell.

Следующие шаги

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