Share via

az grafana dashboard

  • Referenz

Hinweis

Diese Referenz ist Teil der amg-Erweiterung für die Azure CLI (Version 2.38.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen Az grafana Dashboard-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Befehle zum Verwalten von Dashboards einer Instanz.

Befehle

Name Beschreibung Typ Status
az grafana dashboard create

Erstellen Sie ein neues Dashboard.

 Erweiterung Allgemein verfügbar
az grafana dashboard delete

Löschen sie ein Dashboard.

 Erweiterung Allgemein verfügbar
az grafana dashboard import

Importieren sie ein Dashboard.

 Erweiterung Allgemein verfügbar
az grafana dashboard list

Listet alle Dashboards einer Instanz auf.

 Erweiterung Allgemein verfügbar
az grafana dashboard show

Rufen Sie die Details eines Dashboards ab.

 Erweiterung Allgemein verfügbar
az grafana dashboard sync

Synchronisieren Sie Azure Managed Grafana-Dashboards von einer Instanz mit einer anderen Instanz. Beachten Sie, dass Dashboards mit dem Status "bereitgestellt" aufgrund schreibgeschützt übersprungen werden.

 Erweiterung Vorschau
az grafana dashboard update

Aktualisieren sie ein Dashboard.

 Erweiterung Allgemein verfügbar

az grafana dashboard create

Erstellen Sie ein neues Dashboard.

az grafana dashboard create --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]
                            [--title]

Beispiele

Erstellen Sie ein Dashboard mit Definition in einer JSON-Datei. Für den Schnellstart klonen Sie aus der Ausgabe von "az grafana dashboard show", entfernen Sie "id" und "uid", und wenden Sie Änderungen an.

az grafana dashboard create -g MyResourceGroup -n MyGrafana --title "My dashboard" --folder folder1 --definition '{
  "dashboard": {
    "annotations": {
        ...
    },
    "panels": {
        ...
    }
  },
  "message": "Create a new test dashboard"
}'

Erforderliche Parameter

--definition

Das vollständige Dashboardmodell in json-Zeichenfolge, ein Pfad oder eine URL zu einer Datei mit diesem Inhalt.

--name -n

Name des azure Managed Grafana.

Optionale Parameter

--api-key --token -t

Api-Schlüssel- oder Dienstkontotoken, eine zufällig generierte Zeichenfolge, die für die Interaktion mit dem Grafana-Endpunkt verwendet wird; fehlt, verwendet CLI die Anmeldeinformationen des aktuell angemeldeten Benutzers.

--folder

ID, UID, Titel, der einen Ordner identifizieren kann. CLI sucht in der Reihenfolge von ID, UID und Titel, bis eine Übereinstimmung gefunden wird.

--overwrite

Überschreiben Sie ein Dashboard mit derselben UID.

Zulässige Werte: false, true
--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--title

Titel eines Dashboards.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az grafana dashboard delete

Löschen sie ein Dashboard.

az grafana dashboard delete --dashboard
                            --name
                            [--api-key]
                            [--resource-group]

Beispiele

Löschen eines Dashboards, das durch einen eindeutigen Bezeichner angegeben wird(verwenden Sie den Befehl "az grafana dashboard list", um die UID abzurufen)

az grafana dashboard delete -g MyResourceGroup -n MyGrafana --dashboard VdrOA7jGz

Erforderliche Parameter

--dashboard

Dashboard-UID.

--name -n

Name des azure Managed Grafana.

Optionale Parameter

--api-key --token -t

Api-Schlüssel- oder Dienstkontotoken, eine zufällig generierte Zeichenfolge, die für die Interaktion mit dem Grafana-Endpunkt verwendet wird; fehlt, verwendet CLI die Anmeldeinformationen des aktuell angemeldeten Benutzers.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az grafana dashboard import

Importieren sie ein Dashboard.

Der CLI-Befehl füllt die erforderlichen Parameter für Datenquellen aus, wenn diese konfiguriert sind.

az grafana dashboard import --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

Beispiele

Importieren Sie das Dashboard von "AKS Container Insights" aus der Grafana-Galerie.

az grafana dashboard import -g MyResourceGroup -n MyGrafana --definition 12180

Importieren eines Dashboards aus einer Datei.

az grafana dashboard import -g MyResourceGroup -n MyGrafana --definition @c:\temp\dashboard.json

Erforderliche Parameter

--definition

Das vollständige Dashboardmodell in json-Zeichenfolge, Grafana Gallery ID, ein Pfad oder eine URL zu einer Datei mit solchen Inhalten.

--name -n

Name des azure Managed Grafana.

Optionale Parameter

--api-key --token -t

Api-Schlüssel- oder Dienstkontotoken, eine zufällig generierte Zeichenfolge, die für die Interaktion mit dem Grafana-Endpunkt verwendet wird; fehlt, verwendet CLI die Anmeldeinformationen des aktuell angemeldeten Benutzers.

--folder

ID, UID, Titel, der einen Ordner identifizieren kann. CLI sucht in der Reihenfolge von ID, UID und Titel, bis eine Übereinstimmung gefunden wird.

--overwrite

Überschreiben Sie ein Dashboard mit derselben UID.

Zulässige Werte: false, true
--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az grafana dashboard list

Listet alle Dashboards einer Instanz auf.

az grafana dashboard list --name
                          [--api-key]
                          [--resource-group]

Beispiele

Suchen Sie das Dashboard für K8s-API-Server, und rufen Sie den eindeutigen Bezeichner ab(um den Befehl "az grafana dashboard show" aufzurufen)

az grafana dashboard list -g MyResourceGroup -n MyGrafana --query "[?contains(@.title, 'API server')].uid"

Erforderliche Parameter

--name -n

Name des azure Managed Grafana.

Optionale Parameter

--api-key --token -t

Api-Schlüssel- oder Dienstkontotoken, eine zufällig generierte Zeichenfolge, die für die Interaktion mit dem Grafana-Endpunkt verwendet wird; fehlt, verwendet CLI die Anmeldeinformationen des aktuell angemeldeten Benutzers.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az grafana dashboard show

Rufen Sie die Details eines Dashboards ab.

az grafana dashboard show --dashboard
                          --name
                          [--api-key]
                          [--resource-group]

Beispiele

Abrufen von Details zu einem Dashboard, das durch einen eindeutigen Bezeichner angegeben wird(verwenden Sie den Befehl "az grafana dashboard list", um die UID abzurufen)

az grafana dashboard show -g MyResourceGroup -n MyGrafana --dashboard VdrOA7jGz

Erforderliche Parameter

--dashboard

Dashboard-UID.

--name -n

Name des azure Managed Grafana.

Optionale Parameter

--api-key --token -t

Api-Schlüssel- oder Dienstkontotoken, eine zufällig generierte Zeichenfolge, die für die Interaktion mit dem Grafana-Endpunkt verwendet wird; fehlt, verwendet CLI die Anmeldeinformationen des aktuell angemeldeten Benutzers.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az grafana dashboard sync

Vorschau

Dieser Befehl befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Synchronisieren Sie Azure Managed Grafana-Dashboards von einer Instanz mit einer anderen Instanz. Beachten Sie, dass Dashboards mit dem Status "bereitgestellt" aufgrund schreibgeschützt übersprungen werden.

az grafana dashboard sync --destination
                          --source
                          [--dashboards-to-exclude]
                          [--dashboards-to-include]
                          [--dry-run {false, true}]
                          [--folders-to-exclude]
                          [--folders-to-include]

Beispiele

Synchronisieren sie nur Dashboards unter einigen Ordnern

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --folders-to-include "Azure Monitor Container Insights" "Azure Monitor"

Synchronisieren eines einzelnen Dashboards

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --folders-to-include "MyFolder" --dashboards-to-include "My Service Health"

Vorschau der Synchronisierung

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --dry-run

Erforderliche Parameter

--destination -d

Ressourcen-ID des Zielarbeitsbereichs.

--source -s

Ressourcen-ID des Quellarbeitsbereichs.

Optionale Parameter

--dashboards-to-exclude

Getrennte Titel von Dashboards, die in der Synchronisierung ausgeschlossen werden sollen. Koppeln mit --folders-to-exclude für Ordner spezifisch.

--dashboards-to-include

Leerzeichen getrennte Titel von Dashboards, die in die Synchronisierung aufgenommen werden sollen. Koppeln mit --folders-to-include für Ordner spezifisch.

--dry-run

Vorschau von Änderungen beim Commit

Zulässige Werte: false, true
--folders-to-exclude -e

Ordner, die in der Sicherung oder Synchronisierung ausgeschlossen werden sollen.

--folders-to-include -i

Ordner, die in die Sicherung oder Synchronisierung einbezogen werden sollen.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az grafana dashboard update

Aktualisieren sie ein Dashboard.

az grafana dashboard update --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

Beispiele

Aktualisieren Sie ein Dashboard mit Definition in einer JSON-Datei. Um schnell zu beginnen, rufen Sie die vorhandene Konfiguration von "az grafana dashboard show" ab, und wenden Sie Änderungen an. Das Feld "version" muss aktualisiert werden, und das Feld "überschreiben" sollte "true" sein.

az grafana dashboard update -g MyResourceGroup -n MyGrafana --definition @c:\temp\dashboard.json

Erforderliche Parameter

--definition

Das vollständige Dashboardmodell in json-Zeichenfolge, ein Pfad oder eine URL zu einer Datei mit diesem Inhalt.

--name -n

Name des azure Managed Grafana.

Optionale Parameter

--api-key --token -t

Api-Schlüssel- oder Dienstkontotoken, eine zufällig generierte Zeichenfolge, die für die Interaktion mit dem Grafana-Endpunkt verwendet wird; fehlt, verwendet CLI die Anmeldeinformationen des aktuell angemeldeten Benutzers.

--folder

ID, UID, Titel, der einen Ordner identifizieren kann. CLI sucht in der Reihenfolge von ID, UID und Titel, bis eine Übereinstimmung gefunden wird.

--overwrite

Überschreiben Sie ein Dashboard mit derselben UID.

Zulässige Werte: false, true
--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.