Delen via


az grafana dashboard

Notitie

Deze verwijzing maakt deel uit van de amg-extensie voor de Azure CLI (versie 2.61.0 of hoger). De extensie installeert automatisch de eerste keer dat u een opdracht az grafana dashboard uitvoert. Meer informatie over extensies.

Opdrachten voor het beheren van dashboards van een exemplaar.

Opdracht

Name Description Type Status
az grafana dashboard create

Maak een nieuw dashboard.

Toestel GA
az grafana dashboard delete

Een dashboard verwijderen.

Toestel GA
az grafana dashboard import

Een dashboard importeren.

Toestel GA
az grafana dashboard list

Alle dashboards van een exemplaar weergeven.

Toestel GA
az grafana dashboard show

De details van een dashboard ophalen.

Toestel GA
az grafana dashboard sync

Synchroniseer Azure Managed Grafana-dashboards van het ene exemplaar naar een ander exemplaar. Bibliotheekpanelen in de dashboards worden automatisch opgenomen in de synchronisatie. Houd er rekening mee dat dashboards met de status Ingericht worden overgeslagen omdat ze alleen-lezen zijn.

Toestel Preview uitvoeren
az grafana dashboard update

Een dashboard bijwerken.

Toestel GA

az grafana dashboard create

Maak een nieuw dashboard.

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

Voorbeelden

Maak een dashboard met definitie in een json-bestand. Kloon snel aan de slag vanuit de uitvoer van 'az grafana dashboard show', verwijder 'id' en 'uid' en pas wijzigingen toe.

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

Vereiste parameters

--definition

Het volledige dashboardmodel in json-tekenreeks, een pad of URL naar een bestand met dergelijke inhoud.

--name -n

Naam van azure Managed Grafana.

Optionele parameters

--api-key --token -t

Api-sleutel of serviceaccounttoken, een willekeurig gegenereerde tekenreeks die wordt gebruikt voor interactie met Grafana-eindpunt; als dit ontbreekt, gebruikt CLI de referenties van de huidige aangemelde gebruiker.

--folder

Uid of titel die een map kan identificeren. CLI zoekt eerst met uid, vervolgens titel, totdat er een overeenkomst wordt gevonden.

--overwrite

Overschrijf een dashboard met dezelfde uid.

Geaccepteerde waarden: false, true
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--title

Titel van een dashboard.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az grafana dashboard delete

Een dashboard verwijderen.

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

Voorbeelden

Een dashboard verwijderen dat is opgegeven met een unieke id (gebruik de opdracht az grafana dashboard list om de uid op te halen)

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

Vereiste parameters

--dashboard

Dashboard-uid.

--name -n

Naam van azure Managed Grafana.

Optionele parameters

--api-key --token -t

Api-sleutel of serviceaccounttoken, een willekeurig gegenereerde tekenreeks die wordt gebruikt voor interactie met Grafana-eindpunt; als dit ontbreekt, gebruikt CLI de referenties van de huidige aangemelde gebruiker.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az grafana dashboard import

Een dashboard importeren.

De CLI-opdracht vult de vereiste parameters voor gegevensbronnen in als deze is geconfigureerd.

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

Voorbeelden

importeer het dashboard van AKS Container Insights uit de Grafana-galerie.

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

een dashboard importeren uit een bestand.

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

Vereiste parameters

--definition

Het volledige dashboardmodel in json-tekenreeks, grafana-galerie-id, een pad of URL naar een bestand met dergelijke inhoud.

--name -n

Naam van azure Managed Grafana.

Optionele parameters

--api-key --token -t

Api-sleutel of serviceaccounttoken, een willekeurig gegenereerde tekenreeks die wordt gebruikt voor interactie met Grafana-eindpunt; als dit ontbreekt, gebruikt CLI de referenties van de huidige aangemelde gebruiker.

--folder

Uid of titel die een map kan identificeren. CLI zoekt eerst met uid, vervolgens titel, totdat er een overeenkomst wordt gevonden.

--overwrite

Overschrijf een dashboard met dezelfde uid.

Geaccepteerde waarden: false, true
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az grafana dashboard list

Alle dashboards van een exemplaar weergeven.

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

Voorbeelden

Zoek het dashboard voor K8s API Server en haal de unieke id op (om de opdracht az grafana dashboard show aan te roepen)

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

Vereiste parameters

--name -n

Naam van azure Managed Grafana.

Optionele parameters

--api-key --token -t

Api-sleutel of serviceaccounttoken, een willekeurig gegenereerde tekenreeks die wordt gebruikt voor interactie met Grafana-eindpunt; als dit ontbreekt, gebruikt CLI de referenties van de huidige aangemelde gebruiker.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az grafana dashboard show

De details van een dashboard ophalen.

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

Voorbeelden

Details ophalen van een dashboard dat is opgegeven met een unieke id (gebruik de opdracht az grafana dashboard list om de uid op te halen)

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

Vereiste parameters

--dashboard

Dashboard-uid.

--name -n

Naam van azure Managed Grafana.

Optionele parameters

--api-key --token -t

Api-sleutel of serviceaccounttoken, een willekeurig gegenereerde tekenreeks die wordt gebruikt voor interactie met Grafana-eindpunt; als dit ontbreekt, gebruikt CLI de referenties van de huidige aangemelde gebruiker.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az grafana dashboard sync

Preview

Deze opdracht is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Synchroniseer Azure Managed Grafana-dashboards van het ene exemplaar naar een ander exemplaar. Bibliotheekpanelen in de dashboards worden automatisch opgenomen in de synchronisatie. Houd er rekening mee dat dashboards met de status Ingericht worden overgeslagen omdat ze alleen-lezen zijn.

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

Voorbeelden

Alleen dashboards synchroniseren onder een paar mappen

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"

Eén dashboard synchroniseren

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"

Een voorbeeld van de synchronisatie bekijken

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

Vereiste parameters

--destination -d

Resource-id van de doelwerkruimte.

--source -s

Resource-id van de bronwerkruimte.

Optionele parameters

--dashboards-to-exclude

Door ruimte gescheiden titels van dashboards die moeten worden uitgesloten in synchronisatie. Koppelen aan --folders-to-exclude voor specifieke mappen.

--dashboards-to-include

Door ruimte gescheiden titels van dashboards die moeten worden gesynchroniseerd. Koppel deze aan --folders-to-include voor specifieke mappen.

--dry-run

Voorbeeld van wijzigingen met doorvoering.

Geaccepteerde waarden: false, true
--folders-to-exclude -e

Mappen die moeten worden uitgesloten in back-up of synchronisatie.

--folders-to-include -i

Mappen die moeten worden opgenomen in back-up of synchronisatie.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az grafana dashboard update

Een dashboard bijwerken.

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

Voorbeelden

Een dashboard bijwerken met definitie in een json-bestand. Als u snel aan de slag wilt gaan, haalt u de bestaande configuratie op van az grafana dashboard show en past u wijzigingen toe. Het veld 'versie' moet worden bijgewerkt en het veld 'overschrijven' moet waar zijn.

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

Vereiste parameters

--definition

Het volledige dashboardmodel in json-tekenreeks, een pad of URL naar een bestand met dergelijke inhoud.

--name -n

Naam van azure Managed Grafana.

Optionele parameters

--api-key --token -t

Api-sleutel of serviceaccounttoken, een willekeurig gegenereerde tekenreeks die wordt gebruikt voor interactie met Grafana-eindpunt; als dit ontbreekt, gebruikt CLI de referenties van de huidige aangemelde gebruiker.

--folder

Uid of titel die een map kan identificeren. CLI zoekt eerst met uid, vervolgens titel, totdat er een overeenkomst wordt gevonden.

--overwrite

Overschrijf een dashboard met dezelfde uid.

Geaccepteerde waarden: false, true
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.