Démarrage rapide : Exécuter votre première requête Resource Graph à l’aide d’Azure PowerShell

  • Article

La première étape est de vérifier que le module Azure Resource Graph pour Azure PowerShell est installé. Ce guide de démarrage rapide décrit le processus d’ajout du module à votre installation Azure PowerShell.

Au terme de ce processus, vous aurez ajouté le module à l’installation Azure PowerShell de votre choix et vous pourrez exécuter votre première requête Resource Graph.

Prérequis

Si vous n’avez pas d’abonnement Azure, créez un compte gratuit avant de commencer.

Azure Cloud Shell

Azure héberge Azure Cloud Shell, un environnement d’interpréteur de commandes interactif que vous pouvez utiliser dans votre navigateur. Vous pouvez utiliser Bash ou PowerShell avec Cloud Shell pour utiliser les services Azure. Vous pouvez utiliser les commandes préinstallées Cloud Shell pour exécuter le code de cet article sans avoir à installer quoi que ce soit dans votre environnement local.

Pour démarrer Azure Cloud Shell :

Option Exemple/Lien
Sélectionnez Essayer dans le coin supérieur droite d’un bloc de codes ou de commandes. La sélection de Essayer ne copie pas automatiquement le code ni la commande dans Cloud Shell. Screenshot that shows an example of Try It for Azure Cloud Shell.
Accédez à https://shell.azure.com ou sélectionnez le bouton Lancer Cloud Shell pour ouvrir Cloud Shell dans votre navigateur. Button to launch Azure Cloud Shell.
Sélectionnez le bouton Cloud Shell dans la barre de menus en haut à droite du portail Azure. Screenshot that shows the Cloud Shell button in the Azure portal

Pour utiliser Azure Cloud Shell :

  1. Démarrez Cloud Shell.

  2. Sélectionnez le bouton Copier sur un bloc de codes (ou un bloc de commandes) pour copier le code ou la commande.

  3. Collez le code ou la commande dans la session Cloud Shell en sélectionnant Ctrl+Maj+V sur Windows et Linux ou en sélectionnant Cmd+Maj+V sur macOS.

  4. Sélectionnez Entrée pour exécuter le code ou la commande.

Ajouter le module Resource Graph

Pour permettre à Azure PowerShell d’interroger Azure Resource Graph, vous devez ajouter le module. Vous pouvez utiliser ce module avec PowerShell installé localement, avec Azure Cloud Shell ou avec l’image Docker PowerShell.

Configuration de base requise

Le module Azure Resource Graph nécessite les logiciels suivants :

  • Azure PowerShell 1.0.0 ou version ultérieure. S’il n’est pas installé, suivez ces instructions.

  • PowerShellGet 2.0.1 ou une version ultérieure. S’il n’est pas installé ou mis à jour, suivez ces instructions.

Installer le module

Le module Resource Graph pour PowerShell est Az.ResourceGraph.

  1. À partir d’une invite PowerShell d’administration, exécutez la commande suivante :

    # Install the Resource Graph module from PowerShell Gallery
Install-Module -Name Az.ResourceGraph

  2. Vérifiez que le module a été importé et que sa version est supérieure ou égale à 0.11.0 :

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

Exécuter votre première requête Resource Graph

Une fois le module Azure PowerShell ajouté à l’environnement de votre choix, vous pouvez exécuter une requête Resource Graph simple basée sur un locataire. La requête retourne les cinq premières ressources Azure avec le nom (Name) et le Type de chaque ressource. Pour effectuer une requête par groupe d’administration ou par abonnement, utilisez les paramètres -ManagementGroup ou -Subscription.

  1. Exécutez votre première requête Azure Resource Graph à l’aide de l’applet de commande 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'

    Notes

    Comme cet exemple de requête ne fournit pas de modificateur de tri tel que order by, l’exécution répétée de cette requête peut produire un ensemble distinct de ressources par requête.

  2. Mettez à jour la requête pour la trier (order by) en fonction du nom (name) de la propriété :

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

    Notes

    Comme précédemment, l’exécution répétée de cette requête peut produire un ensemble différent de ressources. L’ordre des commandes de requête est important. Dans cet exemple, order by vient après limit. Cet ordre de commande limite d’abord les résultats de la requête, puis les classe.

  3. Mettez à jour la requête pour d’abord trier (order by) les résultats en fonction de la propriété name, puis les limiter (limit) aux cinq premiers :

    # 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

Si votre environnement ne change pas et si vous exécutez plusieurs fois la requête finale, les résultats retournés sont cohérents et classés en fonction de la propriété Name, mais toujours limités aux cinq premiers.

Notes

Si la 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 ID d’abonnement qui font partie du contexte par défaut, exécutez (Get-AzContext).Account.ExtendedProperties.Subscriptions. Si vous souhaitez effectuer une recherche sur tous les abonnements auxquels vous avez accès, vous pouvez définir PSDefaultParameterValues pour l’applet de commande Search-AzGraph en exécutant $PSDefaultParameterValues=@{"Search-AzGraph:Subscription"= $(Get-AzSubscription).ID}.

Nettoyer les ressources

Si vous souhaitez supprimer le module Resource Graph de votre environnement Azure PowerShell, vous pouvez le faire à l’aide de la commande suivante :

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

Notes

Cette opération ne supprime pas le fichier du module téléchargé précédemment. Elle le supprime uniquement de la session PowerShell en cours d’exécution.

Étapes suivantes

Dans ce guide de démarrage rapide, vous avez ajouté le module Resource Graph à votre environnement Azure PowerShell et vous avez exécuté votre première requête. Pour plus d’informations sur le langage Resource Graph, passez à la page des détails du langage de requête.

Obtenir plus d’informations sur le langage de requête