Schnellstart: Ausführen einer Resource Graph-Abfrage unter Verwendung der Azure CLI

  • Artikel

In dieser Schnellstartanleitung erfahren Sie, wie Sie eine Azure Resource Graph-Abfrage unter Verwendung der Erweiterung für die Azure CLI ausführen. Außerdem wird in dem Artikel gezeigt, wie Sie die Ergebnisse der Abfrage sortieren und einschränken. Sie können eine Abfrage für Ressourcen in Ihrem Mandanten, in Verwaltungsgruppen oder in Abonnements ausführen. Nach Abschluss des Vorgangs können Sie die Erweiterung entfernen.

Voraussetzungen

Herstellen einer Verbindung mit Azure

Stellen Sie in einer Visual Studio Code-Terminalsitzung eine Verbindung mit Azure her. Wenn Sie über mehrere Abonnements verfügen, führen Sie die Befehle aus, um den Kontext für Ihr Abonnement festzulegen. Ersetzen Sie <subscriptionID> durch Ihre Azure-Abonnement-ID.

az login

# Run these commands if you have multiple subscriptions
az account list --output table
az account set --subscription <subscriptionID>

Installieren Sie die -Erweiterung.

Damit die Azure CLI Ressourcen unter Verwendung von Azure Resource Graph abfragen kann, muss die Resource Graph-Erweiterung installiert sein. Die Erweiterung kann wie folgt manuell installiert werden. Andernfalls werden Sie beim erstmaligen Ausführen einer Abfrage mit az graph dazu aufgefordert, die Erweiterung zu installieren.

  1. Listen Sie die verfügbaren Erweiterungen und Versionen auf:

    az extension list-available --output table

  2. Installieren Sie die Erweiterung:

    az extension add --name resource-graph

  3. Überprüfen Sie, ob die Erweiterung installiert wurde:

    az extension list --output table

  4. Zeigen Sie die Syntax der Erweiterung an:

    az graph query --help

    Weitere Informationen zu Azure CLI-Erweiterungen finden Sie unter Verwenden und Verwalten von Erweiterungen mit der Azure CLI.

Ausführen einer Abfrage

Nachdem die Azure CLI-Erweiterung zu Ihrer Umgebung hinzugefügt wurde, können Sie eine mandantenbasierte Abfrage ausführen. Die Abfrage in diesem Beispiel gibt fünf Azure-Ressourcen mit dem Namen (name) und Typ (type) der jeweiligen Ressource zurück. Verwenden Sie für eine Abfrage nach Verwaltungsgruppe oder Abonnement die Argumente --management-groups oder --subscriptions.

  1. Führen Sie eine Azure Resource Graph-Abfrage aus:

    az graph query --graph-query 'Resources | project name, type | limit 5'

    In diesem Abfragebeispiel wird kein Sortierungsmodifizierer wie order by verwendet. Wenn Sie die Abfrage mehrfach ausführen, wird möglicherweise für jede Anforderung eine andere Gruppe von Ressourcen zurückgegeben.

  2. Aktualisieren Sie die Abfrage, um die Ergebnisse mithilfe von order by nach der name-Eigenschaft zu sortieren:

    az graph query --graph-query 'Resources | project name, type | limit 5 | order by name asc'

    Genau wie bei der vorherigen Abfrage gilt: Wenn Sie diese Abfrage mehrfach ausführen, wird möglicherweise für jede Anforderung eine andere Gruppe von Ressourcen zurückgegeben. Die Reihenfolge der Abfragebefehle ist wichtig. In diesem Beispiel kommt order by nach limit. Die Abfrage beschränkt die Ergebnisse auf fünf Ressourcen und sortiert diese Ergebnisse dann nach Name.

  3. Aktualisieren Sie die Abfrage, um die Ergebnisse mithilfe von order by nach der name-Eigenschaft zu sortieren und die Ausgabe mithilfe von limit auf fünf Ergebnisse zu beschränken:

    az graph query --graph-query 'Resources | project name, type | order by name asc | limit 5'

    Wenn diese Abfrage mehrmals ausgeführt wird und sich in Ihrer Umgebung nichts geändert hat, sind die Ergebnisse konsistent und nach der name-Eigenschaft sortiert, aber immer noch auf fünf Ergebnisse begrenzt. Die Abfrage sortiert die Ergebnisse nach Name und beschränkt dann die Ausgabe auf fünf Ressourcen.

Bereinigen von Ressourcen

Führen Sie den folgenden Befehl aus, um die Resource Graph-Erweiterung zu entfernen:

az extension remove --name resource-graph

Abmeldung von Ihrer Azure CLI-Sitzung:

az logout

Nächste Schritte

In dieser Schnellstartanleitung haben Sie Azure Resource Graph-Abfragen unter Verwendung der Erweiterung für die Azure CLI ausgeführt. Weitere Informationen finden Sie im Artikel mit Details zur Abfragesprache.

Grundlegendes zur Azure Resource Graph-Abfragesprache