Démarrage rapide : Exécuter une requête Resource Graph à l’aide d’Azure PowerShell

Article
12/04/2024

Ce démarrage rapide décrit comment exécuter une requête Azure Resource Graph à l’aide du Az.ResourceGraph module pour Azure PowerShell. Le module est inclus avec la dernière version d’Azure PowerShell et ajoute des applets de commande pour Resource Graph.

L’article montre également comment classer (trier) et limiter les résultats de la requête. Vous pouvez exécuter une requête pour les ressources de votre locataire, des groupes d’administration ou des abonnements.

Prérequis

Si vous ne disposez pas d’un compte Azure, créez-en un gratuitement avant de commencer.
Dernières versions de PowerShell et d’Azure PowerShell.
Visual Studio Code.

Installez le module

Si vous avez installé les dernières versions de PowerShell et Azure PowerShell, c’est que vous disposez déjà du module Az.ResourceGraph et de la version requise de PowerShellGet.

Installation facultative du module

Suivez les étapes suivantes pour installer le module Az.ResourceGraph afin de pouvoir utiliser Azure PowerShell pour exécuter des requêtes Azure Resource Graph. Le module Azure Resource Graph nécessite PowerShellGet version 2.0.1 ou ultérieure.

Vérifiez votre version de PowerShellGet :
```
Get-Module -Name PowerShellGet
```
Si vous avez besoin de mettre à jour, accédez à PowerShellGet.
Installez le module :
```
Install-Module -Name Az.ResourceGraph -Repository PSGallery -Scope CurrentUser
```
La commande installe le module dans l’étendue CurrentUser. Si vous devez installer dans l’étendue AllUsers, exécutez l’installation à partir d’une session PowerShell d’administration.
Vérifiez que le module a été installé :
```
Get-Command -Module Az.ResourceGraph -CommandType Cmdlet
```
La commande affiche la version de l’applet de commande Search-AzGraph et charge le module dans votre session PowerShell.

Connexion à Azure

Depuis une session de terminal Visual Studio Code, connectez-vous à Azure. Si vous avez plusieurs abonnements, exécutez les commandes pour définir le contexte sur votre abonnement. Remplacez <subscriptionID> par l’identifiant de votre abonnement Azure.

Connect-AzAccount

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

Exécuter une requête

Une fois le module ajouté à votre environnement, vous pouvez exécuter une requête basée sur un locataire. La requête de cet exemple retourne cinq ressources Azure avec les name et les type de chaque ressource. Pour effectuer une requête par groupe d’administration ou par abonnement, utilisez les paramètres -ManagementGroup ou -Subscription.

Exécutez une requête Azure Resource Graph à l’aide de l’applet de commande Search-AzGraph :
```
Search-AzGraph -Query 'Resources | project name, type | limit 5'
```
Cet exemple de requête n’utilise pas de modificateur de tri comme order by. Si vous exécutez la requête plusieurs fois, il se peut que vous obteniez un ensemble de ressources différent pour chaque requête.
Mettre à jour la requête pour order by le name bien :
```
Search-AzGraph -Query 'Resources | project name, type | limit 5 | order by name asc'
```
Comme pour la requête précédente, l’exécution de cette requête plusieurs fois peut vous donner un ensemble de ressources différent pour chaque requête. L’ordre des commandes de requête est important. Dans cet exemple, order by vient après limit. La requête limite les résultats à cinq ressources, puis trie ces résultats par nom.
Mettez à jour la requête en fonction de order by la name propriété, puis la limit sortie en fonction des cinq résultats :
```
Search-AzGraph -Query 'Resources | project name, type | order by name asc | limit 5'
```
Si cette requête est exécutée plusieurs fois sans modification de votre environnement, les résultats sont cohérents et classés par propriété name, mais restent limités à cinq résultats. La requête classe les résultats par nom et limite ensuite le résultat à cinq ressources.

Si une requête ne retourne aucun résultat à partir d’un abonnement auquel vous avez déjà accès, notez que l’applet de commande Search-AzGraph porte par défaut sur les abonnements du contexte par défaut. Pour voir la liste des identifiants d’abonnement qui font partie du contexte par défaut, exécutez ce (Get-AzContext).Account.ExtendedProperties.Subscriptions Si vous souhaitez effectuer une recherche parmi tous les abonnements auxquels vous avez accès, définissez le PSDefaultParameterValues pour la Search-AzGraph cmdlet en exécutant la commande suivante $PSDefaultParameterValues=@{"Search-AzGraph:Subscription"= $(Get-AzSubscription).ID}

Nettoyer les ressources

Pour vous déconnecter de votre session Azure PowerShell :

Disconnect-AzAccount

Étapes de nettoyage facultatives

Si vous avez installé la dernière version d’Azure PowerShell, sachez que le module Az.ResourceGraph est inclus et ne doit pas être supprimé. Les étapes suivantes sont facultatives si vous avez effectué une installation manuelle du module Az.ResourceGraph et souhaitez supprimer le module.

Pour supprimer le module Az.ResourceGraph de votre session PowerShell, exécutez la commande suivante :

Remove-Module -Name Az.ResourceGraph

Pour désinstaller le module Az.ResourceGraph à partir de votre ordinateur, exécutez la commande suivante :

Uninstall-Module -Name Az.ResourceGraph

Un message peut s’afficher, car module Az.ResourceGraph est actuellement en cours d’utilisation. Si c’est le cas, vous devez arrêter votre session PowerShell et démarrer une nouvelle session. Exécutez ensuite la commande pour désinstaller le module de votre ordinateur.

Étapes suivantes

Dans ce démarrage rapide, vous avez ajouté le module Resource Graph à votre environnement Azure PowerShell et exécuté une requête. Pour en savoir plus, accédez à la page sur les détails du langage de requête.

Présentation du langage de requête Azure Resource Graph

Partager via