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

  • Artikel

In deze quickstart wordt beschreven hoe u een Azure Resource Graph-query uitvoert met behulp van de Az.ResourceGraph module voor Azure PowerShell. In het artikel wordt ook beschreven hoe u de resultaten van de query sorteert (sorteert) en beperkt. U kunt een query uitvoeren voor resources in uw tenant, beheergroepen of abonnementen. Wanneer u klaar bent, kunt u de module verwijderen.

Vereisten

Installeer de module

Installeer de Az.ResourceGraph module zodat u Azure PowerShell kunt gebruiken om Azure Resource Graph-query's uit te voeren. Voor de Azure Resource Graph-module is PowerShellGet versie 2.0.1 of hoger vereist. Als u de nieuwste versies van PowerShell en Azure PowerShell hebt geïnstalleerd, hebt u al de vereiste versie.

  1. Controleer uw PowerShellGet-versie:

    Get-Module -Name PowerShellGet

    Als u wilt bijwerken, gaat u naar PowerShellGet.

  2. Installeer de module:

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

    Met de opdracht wordt de module in het CurrentUser bereik geïnstalleerd. Als u in het AllUsers bereik wilt installeren, voert u de installatie uit vanuit een PowerShell-sessie met beheerdersrechten.

  3. Controleer of de module is geïnstalleerd:

    Get-Command -Module Az.ResourceGraph -CommandType Cmdlet

    De opdracht geeft de cmdlet-versie Search-AzGraph weer en laadt de module in uw PowerShell-sessie.

Verbinding maken met Azure

Maak vanuit een Visual Studio Code-terminalsessie verbinding met Azure. Als u meer dan één abonnement hebt, voert u de opdrachten uit om context in te stellen op uw abonnement. Vervang <subscriptionID> door de id van uw Azure-abonnement.

Connect-AzAccount

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

Een query uitvoeren

Nadat de module is toegevoegd aan uw omgeving, kunt u een query op basis van een tenant uitvoeren. De query in dit voorbeeld retourneert vijf Azure-resources met de name en type van elke resource. Als u een query wilt uitvoeren op een beheergroep of abonnement, gebruikt u de -ManagementGroup of -Subscription parameters.

  1. Voer een Azure Resource Graph-query uit met behulp van de Search-AzGraph cmdlet:

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

    In dit queryvoorbeeld wordt geen sorteeraanpassing zoals order by. Als u de query meerdere keren uitvoert, kan dit een andere set resources opleveren voor elke aanvraag.

  2. Werk de query bij naar order by de name eigenschap:

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

    Net als bij de vorige query kan het zijn dat als u deze query meerdere keren uitvoert een andere set resources voor elke aanvraag oplevert. De volgorde van de queryopdrachten is belangrijk. In dit voorbeeld komt order by na limit. De query beperkt de resultaten tot vijf resources en bestelt deze resultaten vervolgens op naam.

  3. Werk de query bij naar order by de name eigenschap en vervolgens limit de uitvoer naar vijf resultaten:

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

    Als deze query meerdere keren wordt uitgevoerd zonder wijzigingen in uw omgeving, zijn de resultaten consistent en gerangschikt door de name eigenschap, maar nog steeds beperkt tot vijf resultaten. Met de query worden de resultaten op naam gesorteerd en wordt de uitvoer beperkt tot vijf resources.

Als een query geen resultaten retourneert van een abonnement waartoe u al toegang hebt, moet u er rekening mee houden dat Search-AzGraph de cmdlet standaard wordt gebruikt voor abonnementen in de standaardcontext. Als u de lijst met abonnements-id's wilt zien die deel uitmaken van de standaardcontext, voert u deze (Get-AzContext).Account.ExtendedProperties.Subscriptions opdracht uit als u wilt zoeken in alle abonnementen waartoe u toegang hebt, stelt u de voor Search-AzGraph cmdlet in door de PSDefaultParameterValues cmdlet uit te voeren$PSDefaultParameterValues=@{"Search-AzGraph:Subscription"= $(Get-AzSubscription).ID}

Resources opschonen

Als u de Az.ResourceGraph module uit uw PowerShell-sessie wilt verwijderen, voert u de volgende opdracht uit:

Remove-Module -Name Az.ResourceGraph

Voer de volgende opdracht uit om de Az.ResourceGraph module van uw computer te verwijderen:

Uninstall-Module -Name Az.ResourceGraph

Er wordt mogelijk een bericht weergegeven dat module Az.ResourceGraph momenteel in gebruik is. Zo ja, dan moet u uw PowerShell-sessie afsluiten en een nieuwe sessie starten. Voer vervolgens de opdracht uit om de module van uw computer te verwijderen.

Afmelden bij uw Azure PowerShell-sessie:

Disconnect-AzAccount

Volgende stappen

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

Informatie over de querytaal van Azure Resource Graph