Szybki start: uruchamianie zapytania usługi Resource Graph przy użyciu programu Azure PowerShell

  • Artykuł

W tym przewodniku Szybki start opisano sposób uruchamiania zapytania usługi Azure Resource Graph przy użyciu modułu Az.ResourceGraph dla programu Azure PowerShell. W tym artykule pokazano również, jak uporządkować (sortować) i ograniczyć wyniki zapytania. Możesz uruchomić zapytanie dotyczące zasobów w dzierżawie, grupach zarządzania lub subskrypcjach. Po zakończeniu możesz usunąć moduł.

Wymagania wstępne

Instalowanie modułu

Az.ResourceGraph Zainstaluj moduł, aby umożliwić uruchamianie zapytań usługi Azure Resource Graph przy użyciu programu Azure PowerShell. Moduł Azure Resource Graph wymaga modułu PowerShellGet w wersji 2.0.1 lub nowszej. Jeśli zainstalowano najnowsze wersje programu PowerShell i programu Azure PowerShell, masz już wymaganą wersję.

  1. Sprawdź wersję modułu PowerShellGet:

    Get-Module -Name PowerShellGet

    Jeśli musisz zaktualizować, przejdź do pozycji PowerShellGet.

  2. Instalowanie modułu:

    Install-Module -Name Az.ResourceGraph -Repository PSGallery -Scope CurrentUser

    Polecenie instaluje moduł w CurrentUser zakresie. Jeśli musisz zainstalować w AllUsers zakresie, uruchom instalację z sesji administracyjnej programu PowerShell.

  3. Sprawdź, czy moduł został zainstalowany:

    Get-Command -Module Az.ResourceGraph -CommandType Cmdlet

    Polecenie wyświetla Search-AzGraph wersję polecenia cmdlet i ładuje moduł do sesji programu PowerShell.

Łączenie się z platformą Azure

Z poziomu sesji terminalu programu Visual Studio Code nawiąż połączenie z platformą Azure. Jeśli masz więcej niż jedną subskrypcję, uruchom polecenia, aby ustawić kontekst na subskrypcję. Zamień wartość <subscriptionID> na identyfikator swojej subskrypcji platformy Azure.

Connect-AzAccount

# Run these commands if you have multiple subscriptions
Get-AzSubScription
Set-AzContext -Subscription <subscriptionID>

Uruchamianie zapytania

Po dodaniu modułu do środowiska można uruchomić zapytanie oparte na dzierżawie. Zapytanie w tym przykładzie zwraca pięć zasobów platformy Azure z wartościami name i type każdego zasobu. Aby wykonywać zapytania według grupy zarządzania lub subskrypcji, użyj -ManagementGroup parametrów lub -Subscription .

  1. Uruchom zapytanie usługi Azure Resource Graph przy użyciu Search-AzGraph polecenia cmdlet :

    Search-AzGraph -Query 'Resources | project name, type | limit 5'

    Ten przykład zapytania nie używa modyfikatora sortowania, takiego jak order by. W przypadku wielokrotnego uruchamiania zapytania może to spowodować uzyskanie innego zestawu zasobów dla każdego żądania.

  2. Zaktualizuj zapytanie do order byname właściwości:

    Search-AzGraph -Query 'Resources | project name, type | limit 5 | order by name asc'

    Podobnie jak w przypadku poprzedniego zapytania, jeśli to zapytanie jest uruchamiane wielokrotnie, może spowodować uzyskanie innego zestawu zasobów dla każdego żądania. Kolejność poleceń zapytania jest ważna. W tym przykładzie polecenie order by następuje po poleceniu limit. Zapytanie ogranicza wyniki do pięciu zasobów, a następnie porządkuje te wyniki według nazwy.

  3. Zaktualizuj zapytanie do właściwości, a następnie limit dane wyjściowe do order byname pięciu wyników:

    Search-AzGraph -Query 'Resources | project name, type | order by name asc | limit 5'

    Jeśli to zapytanie jest uruchamiane kilka razy bez zmian w środowisku, wyniki są spójne i uporządkowane według name właściwości, ale nadal ograniczone do pięciu wyników. Zapytanie porządkuje wyniki według nazwy, a następnie ogranicza dane wyjściowe do pięciu zasobów.

Jeśli zapytanie nie zwraca wyników z subskrypcji, do której masz już dostęp, zwróć uwagę, że Search-AzGraph polecenie cmdlet domyślnie jest domyślnie subskrypcjami w kontekście domyślnym. Aby wyświetlić listę identyfikatorów subskrypcji, które są częścią kontekstu domyślnego, uruchom polecenie (Get-AzContext).Account.ExtendedProperties.Subscriptions Jeśli chcesz wyszukać we wszystkich subskrypcjach, do których masz dostęp, ustaw PSDefaultParameterValues dla Search-AzGraph polecenia cmdlet, uruchamiając polecenie cmdlet $PSDefaultParameterValues=@{"Search-AzGraph:Subscription"= $(Get-AzSubscription).ID}

Czyszczenie zasobów

Aby usunąć Az.ResourceGraph moduł z sesji programu PowerShell, uruchom następujące polecenie:

Remove-Module -Name Az.ResourceGraph

Aby odinstalować Az.ResourceGraph moduł z komputera, uruchom następujące polecenie:

Uninstall-Module -Name Az.ResourceGraph

Może zostać wyświetlony komunikat, że moduł Az.ResourceGraph jest obecnie używany. Jeśli tak, musisz zamknąć sesję programu PowerShell i rozpocząć nową sesję. Następnie uruchom polecenie , aby odinstalować moduł z komputera.

Aby wylogować się z sesji programu Azure PowerShell:

Disconnect-AzAccount

Następne kroki

W tym przewodniku Szybki start dodano moduł Resource Graph do środowiska programu Azure PowerShell i uruchomiono zapytanie. Aby dowiedzieć się więcej, przejdź do strony szczegółów języka zapytań.

Omówienie języka zapytań usługi Azure Resource Graph