Quickstart: Uw eerste Resource Graph-query uitvoeren met behulp van Azure PowerShell

De eerste stap voor het gebruik van Azure Resource Graph bestaat uit het controleren of de module voor Azure PowerShell is geïnstalleerd. In deze snelstartgids doorloopt u het proces voor het toevoegen van de module aan uw Azure PowerShell-installatie.

Aan het einde van dit proces hebt u de module toegevoegd aan de Azure PowerShell-installatie van uw keuze en hebt u uw eerste Resource Graph-query uitgevoerd.

Vereisten

Als u geen Azure-abonnement hebt, maakt u een gratis account voordat u begint.

Azure Cloud Shell

Azure host Azure Cloud Shell, een interactieve shell-omgeving die u via uw browser kunt gebruiken. U kunt Bash of PowerShell gebruiken met Cloud Shell om met Azure-services te werken. U kunt de vooraf geïnstalleerde Cloud Shell-opdrachten gebruiken om de code in dit artikel uit te voeren zonder dat u iets hoeft te installeren in uw lokale omgeving.

Om Azure Cloud Shell op te starten:

Optie Voorbeeld/koppeling
Selecteer Uitproberen in de rechterbovenhoek van een code- of opdrachtblok. Als u Try It selecteert, wordt de code of opdracht niet automatisch gekopieerd naar Cloud Shell. Screenshot that shows an example of Try It for Azure Cloud Shell.
Ga naar https://shell.azure.com, of selecteer de knop Cloud Shell starten om Cloud Shell in uw browser te openen. Button to launch Azure Cloud Shell.
Klik op de knop Cloud Shell in het menu in de balk rechtsboven in de Azure-portal. Screenshot that shows the Cloud Shell button in the Azure portal

Azure Cloud Shell gebruiken:

  1. Start Cloud Shell.

  2. Selecteer de knop Kopiëren op een codeblok (of opdrachtblok) om de code of opdracht te kopiëren.

  3. Plak de code of opdracht in de Cloud Shell-sessie door Ctrl+Shift+V in Windows en Linux te selecteren of door Cmd+Shift+V te selecteren in macOS.

  4. Selecteer Enter om de code of opdracht uit te voeren.

De Resource Graph-module toevoegen

De module moet worden toegevoegd opdat Azure PowerShell query's kan uitvoeren voor Azure Resource Graph. Deze module kan worden gebruikt met lokaal geïnstalleerde PowerShell, met Azure Cloud Shell of met de PowerShell Docker-installatiekopie.

Basisvereisten

Voor de Azure Resource Graph-module is de volgende software vereist:

  • Azure PowerShell 1.0.0 of hoger. Als deze nog niet is geïnstalleerd, volgt u deze instructies op.

  • PowerShellGet 2.0.1 of hoger. Als deze nog niet is geïnstalleerd of bijgewerkt, volgt u deze instructies op.

Installeer de module

De Resource Graph-module voor PowerShell is Az.ResourceGraph.

  1. Voer vanuit een PowerShell-prompt met beheerdersrechten de volgende opdracht uit:

    # Install the Resource Graph module from PowerShell Gallery
    Install-Module -Name Az.ResourceGraph
    
  2. Controleer of de module is geïmporteerd en ten minste versie 0.11.0is:

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

Uw eerste Resource Graph-query uitvoeren

Nu de Azure PowerShell-module is toegevoegd aan uw gewenste omgeving, is het tijd om een eenvoudige Resource Graph-query op basis van een tenant uit te proberen. De query retourneert de eerste vijf Azure-resources met de naam en het resourcetype van elke resource. Als u een query wilt uitvoeren op een beheergroep of abonnement, gebruikt u de -ManagementGroup of -Subscription parameters.

  1. Voer als volgt uw eerste Azure Resource Graph-query uit met de cmdlet 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'
    

    Notitie

    Omdat deze voorbeeldquery geen sorteermodificator geeft, bijvoorbeeld order by, zal deze query waarschijnlijk per aanvraag een andere set resources opleveren als de query meerdere keren wordt uitgevoerd.

  2. Werk de query als volgt bij om de eigenschap naam te order by:

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

    Notitie

    Net als bij de eerste query zal deze query waarschijnlijk per aanvraag een andere set resources opleveren als de query meerdere keren wordt uitgevoerd. De volgorde van de queryopdrachten is belangrijk. In dit voorbeeld komt order by na limit. Met deze opdracht worden de queryresultaten eerst beperkt en vervolgens gerangschikt.

  3. Werk de query als volgt bij om eerst te order by op de eigenschap naam en daarna de resultaten van de top vijf te 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
    

Wanneer de laatste query meerdere keren wordt uitgevoerd, ervan uitgaande dat er niets in uw omgeving verandert, zijn de geretourneerde resultaten consistent en geordend door de eigenschap Name , maar nog steeds beperkt tot de top vijf resultaten.

Notitie

Als de query geen resultaten oplevert van een abonnement waartoe u al toegang hebt, zal de cmdlet Search-AzGraph standaard worden ingesteld op abonnementen in de standaardcontext. Als u de lijst met abonnements-id's wilt weergeven die deel uitmaken van de standaardcontext, voert u de opdracht (Get-AzContext).Account.ExtendedProperties.Subscriptions uit. Als u in alle abonnementen wilt doorzoeken waartoe u toegang hebt, kunt u PSDefaultParameterValues voor de cmdlet Search-AzGraph instellen door de opdracht $PSDefaultParameterValues=@{"Search-AzGraph:Subscription"= $(Get-AzSubscription).ID} uit te voeren.

Resources opschonen

Als u de Resource Graph-module uit uw Azure PowerShell-omgeving wilt verwijderen, kunt u dit doen met de volgende opdracht:

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

Notitie

Hiermee verwijdert u niet het modulebestand dat u eerder hebt gedownload. U verwijdert deze alleen uit de actieve PowerShell-sessie.

Volgende stappen

In deze quickstart hebt u de Resource Graph-module toegevoegd aan uw Azure PowerShell-omgeving en uw eerste query uitgevoerd. Ga verder naar de pagina met details van de querytaal voor meer informatie over de taal van Resource Graph.