Share via

az grafana dashboard

  • Riferimento

Nota

Questo riferimento fa parte dell'estensione amg per l'interfaccia della riga di comando di Azure (versione 2.38.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az grafana dashboard . Altre informazioni sulle estensioni.

Comandi per gestire i dashboard di un'istanza.

Comandi

Nome Descrizione Tipo Stato
az grafana dashboard create

Creare un nuovo dashboard.

 Estensione Disponibilità generale
az grafana dashboard delete

Eliminare un dashboard.

 Estensione Disponibilità generale
az grafana dashboard import

Importare un dashboard.

 Estensione Disponibilità generale
az grafana dashboard list

Elencare tutti i dashboard di un'istanza.

 Estensione Disponibilità generale
az grafana dashboard show

Ottenere i dettagli di un dashboard.

 Estensione Disponibilità generale
az grafana dashboard sync

Sincronizzare i dashboard di Grafana gestiti di Azure da un'istanza a un'altra. Si noti che i dashboard con stato "provisioning" verranno ignorati a causa della sola lettura.

 Estensione Anteprima
az grafana dashboard update

Aggiornare un dashboard.

 Estensione Disponibilità generale

az grafana dashboard create

Creare un nuovo dashboard.

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

Esempio

Creare un dashboard con definizione in un file JSON. Per iniziare rapidamente, clonare dall'output di "az grafana dashboard show", rimuovere "id" e "uid" e applicare le modifiche.

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

Parametri necessari

--definition

Modello di dashboard completo in stringa JSON, percorso o URL di un file con tale contenuto.

--name -n

Nome della Grafana gestita di Azure.

Parametri facoltativi

--api-key --token -t

Chiave API o token dell'account del servizio, stringa generata in modo casuale usata per interagire con l'endpoint Grafana; se mancante, l'interfaccia della riga di comando userà le credenziali dell'utente connesso corrente.

--folder

ID, uid, titolo che può identificare una cartella. L'interfaccia della riga di comando cercherà nell'ordine di ID, uid e titolo, fino a trovare una corrispondenza.

--overwrite

Sovrascrivere un dashboard con lo stesso uid.

valori accettati: false, true
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--title

Titolo di un dashboard.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az grafana dashboard delete

Eliminare un dashboard.

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

Esempio

Eliminare un dashboard specificato da un identificatore univoco(usare il comando "az grafana dashboard list" per recuperare l'uid)

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

Parametri necessari

--dashboard

Uid dashboard.

--name -n

Nome della Grafana gestita di Azure.

Parametri facoltativi

--api-key --token -t

Chiave API o token dell'account del servizio, stringa generata in modo casuale usata per interagire con l'endpoint Grafana; se mancante, l'interfaccia della riga di comando userà le credenziali dell'utente connesso corrente.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az grafana dashboard import

Importare un dashboard.

Se configurato, il comando dell'interfaccia della riga di comando compilerà i parametri obbligatori per le origini dati.

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

Esempio

importare il dashboard di "Azure Kubernetes Container Insights" dalla raccolta Grafana.

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

importare un dashboard da un file.

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

Parametri necessari

--definition

Il modello di dashboard completo in stringa json, ID raccolta Grafana, percorso o URL di un file con tale contenuto.

--name -n

Nome della Grafana gestita di Azure.

Parametri facoltativi

--api-key --token -t

Chiave API o token dell'account del servizio, stringa generata in modo casuale usata per interagire con l'endpoint Grafana; se mancante, l'interfaccia della riga di comando userà le credenziali dell'utente connesso corrente.

--folder

ID, uid, titolo che può identificare una cartella. L'interfaccia della riga di comando cercherà nell'ordine di ID, uid e titolo, fino a trovare una corrispondenza.

--overwrite

Sovrascrivere un dashboard con lo stesso uid.

valori accettati: false, true
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az grafana dashboard list

Elencare tutti i dashboard di un'istanza.

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

Esempio

Trovare il dashboard per il server API K8s e recuperare l'identificatore univoco(per richiamare il comando "az grafana dashboard show")

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

Parametri necessari

--name -n

Nome della Grafana gestita di Azure.

Parametri facoltativi

--api-key --token -t

Chiave API o token dell'account del servizio, stringa generata in modo casuale usata per interagire con l'endpoint Grafana; se mancante, l'interfaccia della riga di comando userà le credenziali dell'utente connesso corrente.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az grafana dashboard show

Ottenere i dettagli di un dashboard.

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

Esempio

Ottenere i dettagli di un dashboard specificato da un identificatore univoco(usare il comando "az grafana dashboard list" per recuperare l'uid)

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

Parametri necessari

--dashboard

Uid dashboard.

--name -n

Nome della Grafana gestita di Azure.

Parametri facoltativi

--api-key --token -t

Chiave API o token dell'account del servizio, stringa generata in modo casuale usata per interagire con l'endpoint Grafana; se mancante, l'interfaccia della riga di comando userà le credenziali dell'utente connesso corrente.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az grafana dashboard sync

Anteprima

Questo comando è in anteprima e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Sincronizzare i dashboard di Grafana gestiti di Azure da un'istanza a un'altra. Si noti che i dashboard con stato "provisioning" verranno ignorati a causa della sola lettura.

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

Esempio

Sincronizzare solo i dashboard in alcune cartelle

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"

Sincronizzare un singolo dashboard

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"

Visualizzare in anteprima la sincronizzazione

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

Parametri necessari

--destination -d

ID risorsa dell'area di lavoro di destinazione.

--source -s

ID risorsa dell'area di lavoro di origine.

Parametri facoltativi

--dashboards-to-exclude

Spaziare i titoli separati dei dashboard da escludere nella sincronizzazione. Associa a --folders-to-exclude per le cartelle specifiche.

--dashboards-to-include

Spaziare i titoli separati dei dashboard da includere nella sincronizzazione. Associa a --folders-to-include per cartelle specifiche.

--dry-run

Anteprima delle modifiche w/o commit.

valori accettati: false, true
--folders-to-exclude -e

Cartelle da escludere nel backup o nella sincronizzazione.

--folders-to-include -i

Cartelle da includere nel backup o nella sincronizzazione.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az grafana dashboard update

Aggiornare un dashboard.

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

Esempio

Aggiornare un dashboard con definizione in un file JSON. Per iniziare rapidamente, ottenere la configurazione esistente da "az grafana dashboard show" e applicare le modifiche. Il campo "version" deve essere aggiornato e il campo "overwrite" deve essere true.

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

Parametri necessari

--definition

Modello di dashboard completo in stringa JSON, percorso o URL di un file con tale contenuto.

--name -n

Nome della Grafana gestita di Azure.

Parametri facoltativi

--api-key --token -t

Chiave API o token dell'account del servizio, stringa generata in modo casuale usata per interagire con l'endpoint Grafana; se mancante, l'interfaccia della riga di comando userà le credenziali dell'utente connesso corrente.

--folder

ID, uid, titolo che può identificare una cartella. L'interfaccia della riga di comando cercherà nell'ordine di ID, uid e titolo, fino a trovare una corrispondenza.

--overwrite

Sovrascrivere un dashboard con lo stesso uid.

valori accettati: false, true
--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

Parametri globali
--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
valore predefinito: json
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.