az grafana dashboard

  • Référence

Remarque

Cette référence fait partie de l’extension amg pour Azure CLI (version 2.38.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande de tableau de bord az grafana. En savoir plus sur les extensions.

Commandes pour gérer les tableaux de bord d’une instance.

Commandes

Nom Description Type Statut
az grafana dashboard create

Créez un tableau de bord.

 Extension GA
az grafana dashboard delete

Supprimez un tableau de bord.

 Extension GA
az grafana dashboard import

Importez un tableau de bord.

 Extension GA
az grafana dashboard list

Répertorier tous les tableaux de bord d’une instance.

 Extension GA
az grafana dashboard show

Obtenez les détails d’un tableau de bord.

 Extension GA
az grafana dashboard sync

Synchronisez les tableaux de bord Azure Managed Grafana d’une instance à une autre instance. Notez que les tableaux de bord avec l’état « provisionné » sont ignorés en raison d’une lecture seule.

 Extension Aperçu
az grafana dashboard update

Mettez à jour un tableau de bord.

 Extension GA

az grafana dashboard create

Créez un tableau de bord.

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

Exemples

Créez un tableau de bord avec une définition dans un fichier json. Pour démarrer rapidement, clonez à partir de la sortie de « az grafana dashboard show », supprimez « id » et « uid » et appliquez les modifications.

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

Paramètres obligatoires

--definition

Modèle de tableau de bord complet dans une chaîne json, un chemin d’accès ou une URL vers un fichier avec ce contenu.

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--api-key --token -t

Jeton de clé api ou de compte de service, chaîne générée de manière aléatoire utilisée pour interagir avec le point de terminaison Grafana ; si elle est manquante, l’interface CLI utilise les informations d’identification de l’utilisateur connecté en cours.

--folder

ID, uid, titre qui peut identifier un dossier. L’interface CLI recherche dans l’ordre d’ID, d’uid et de titre, jusqu’à ce qu’une correspondance soit trouvée.

--overwrite

Remplacez un tableau de bord avec le même uid.

valeurs acceptées: false, true
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--title

Titre d’un tableau de bord.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az grafana dashboard delete

Supprimez un tableau de bord.

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

Exemples

Supprimer un tableau de bord spécifié par un identificateur unique(utilisez la commande « az grafana dashboard list » pour récupérer l’interface utilisateur)

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

Paramètres obligatoires

--dashboard

Uid du tableau de bord.

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--api-key --token -t

Jeton de clé api ou de compte de service, chaîne générée de manière aléatoire utilisée pour interagir avec le point de terminaison Grafana ; si elle est manquante, l’interface CLI utilise les informations d’identification de l’utilisateur connecté en cours.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az grafana dashboard import

Importez un tableau de bord.

La commande CLI renseigne les paramètres requis pour les sources de données s’il est configuré.

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

Exemples

importez le tableau de bord « AKS Container Recommandations » à partir de la galerie Grafana.

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

importez un tableau de bord à partir d’un fichier.

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

Paramètres obligatoires

--definition

Modèle de tableau de bord complet dans la chaîne json, l’ID de galerie Grafana, un chemin d’accès ou une URL vers un fichier avec ce contenu.

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--api-key --token -t

Jeton de clé api ou de compte de service, chaîne générée de manière aléatoire utilisée pour interagir avec le point de terminaison Grafana ; si elle est manquante, l’interface CLI utilise les informations d’identification de l’utilisateur connecté en cours.

--folder

ID, uid, titre qui peut identifier un dossier. L’interface CLI recherche dans l’ordre d’ID, d’uid et de titre, jusqu’à ce qu’une correspondance soit trouvée.

--overwrite

Remplacez un tableau de bord avec le même uid.

valeurs acceptées: false, true
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az grafana dashboard list

Répertorier tous les tableaux de bord d’une instance.

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

Exemples

Recherchez le tableau de bord du serveur d’API K8s et récupérez l’identificateur unique (pour appeler la commande « az grafana dashboard show »)

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

Paramètres obligatoires

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--api-key --token -t

Jeton de clé api ou de compte de service, chaîne générée de manière aléatoire utilisée pour interagir avec le point de terminaison Grafana ; si elle est manquante, l’interface CLI utilise les informations d’identification de l’utilisateur connecté en cours.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az grafana dashboard show

Obtenez les détails d’un tableau de bord.

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

Exemples

Obtenir les détails d’un tableau de bord spécifié par un identificateur unique (utilisez la commande « az grafana dashboard list » pour récupérer l’interface utilisateur)

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

Paramètres obligatoires

--dashboard

Uid du tableau de bord.

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--api-key --token -t

Jeton de clé api ou de compte de service, chaîne générée de manière aléatoire utilisée pour interagir avec le point de terminaison Grafana ; si elle est manquante, l’interface CLI utilise les informations d’identification de l’utilisateur connecté en cours.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az grafana dashboard sync

Préversion

Cette commande est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Synchronisez les tableaux de bord Azure Managed Grafana d’une instance à une autre instance. Notez que les tableaux de bord avec l’état « provisionné » sont ignorés en raison d’une lecture seule.

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

Exemples

Synchroniser uniquement les tableaux de bord sous quelques dossiers

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"

Synchroniser un tableau de bord unique

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"

Afficher un aperçu de la synchronisation

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

Paramètres obligatoires

--destination -d

ID de ressource de l’espace de travail de destination.

--source -s

ID de ressource de l’espace de travail source.

Paramètres facultatifs

--dashboards-to-exclude

Titres séparés d’espace des tableaux de bord à exclure dans la synchronisation. Associez --folders-to-exclude pour les dossiers spécifiques.

--dashboards-to-include

Titres séparés d’espace des tableaux de bord à inclure dans la synchronisation. Associez --folders-to-include pour les dossiers spécifiques.

--dry-run

Aperçu des modifications w/o commiting.

valeurs acceptées: false, true
--folders-to-exclude -e

Dossiers à exclure dans la sauvegarde ou la synchronisation.

--folders-to-include -i

Dossiers à inclure dans la sauvegarde ou la synchronisation.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az grafana dashboard update

Mettez à jour un tableau de bord.

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

Exemples

Mettez à jour un tableau de bord avec une définition dans un fichier json. Pour démarrer rapidement, obtenez la configuration existante à partir de « az grafana dashboard show » et appliquez des modifications. Le champ « version » doit être mis à jour et le champ « remplacer » doit être vrai.

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

Paramètres obligatoires

--definition

Modèle de tableau de bord complet dans une chaîne json, un chemin d’accès ou une URL vers un fichier avec ce contenu.

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--api-key --token -t

Jeton de clé api ou de compte de service, chaîne générée de manière aléatoire utilisée pour interagir avec le point de terminaison Grafana ; si elle est manquante, l’interface CLI utilise les informations d’identification de l’utilisateur connecté en cours.

--folder

ID, uid, titre qui peut identifier un dossier. L’interface CLI recherche dans l’ordre d’ID, d’uid et de titre, jusqu’à ce qu’une correspondance soit trouvée.

--overwrite

Remplacez un tableau de bord avec le même uid.

valeurs acceptées: false, true
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.