az grafana

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 az grafana . En savoir plus sur les extensions.

Commandes pour gérer les instances Azure Grafana.

Pour une expérience optimisée, toutes les API de plan de données, documentées à l’adresse https://grafana.com/docs/grafana/latest/http_api/, ne sont pas exposées. En cas d’écart de couverture, veuillez contacter ad4g@microsoft.com.

Commandes

Nom Description Type Statut
az grafana api-key

Commandes pour gérer les clés API.

Extension GA
az grafana api-key create

Créez une clé API.

Extension GA
az grafana api-key delete

Supprimez une clé API.

Extension GA
az grafana api-key list

Répertorier les clés API existantes.

Extension GA
az grafana backup

Sauvegardez le contenu d’une instance Azure Managed Grafana dans une archive.

Extension Aperçu
az grafana create

Créez une instance Azure Managed Grafana.

Extension GA
az grafana dashboard

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

Extension GA
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 data-source

Commandes pour gérer les sources de données d’une instance.

Extension GA
az grafana data-source create

Créez une source de données.

Extension GA
az grafana data-source delete

Supprimer une source de données.

Extension GA
az grafana data-source list

Répertorier toutes les sources de données d’une instance.

Extension GA
az grafana data-source query

Interrogez une source de données ayant une implémentation back-end.

Extension GA
az grafana data-source show

Obtenez les détails d’une source de données.

Extension GA
az grafana data-source update

Mettez à jour une source de données.

Extension GA
az grafana delete

Supprimez une instance Azure Managed Grafana.

Extension GA
az grafana folder

Commandes pour gérer les dossiers d’une instance.

Extension GA
az grafana folder create

Créer un dossier.

Extension GA
az grafana folder delete

Supprimez un dossier.

Extension GA
az grafana folder list

Répertoriez tous les dossiers d’une instance.

Extension GA
az grafana folder show

Obtenez les détails d’un dossier.

Extension GA
az grafana folder update

Mettez à jour un dossier.

Extension GA
az grafana list

Répertorier les instances Azure Managed Grafana.

Extension GA
az grafana notification-channel

Commandes pour gérer les canaux de notification d’une instance.

Extension GA
az grafana notification-channel create

Créez un canal de notification.

Extension GA
az grafana notification-channel delete

Supprimez un canal de notification.

Extension GA
az grafana notification-channel list

Répertoriez tous les canaux de notification d’une instance.

Extension GA
az grafana notification-channel show

Obtenez les détails d’un canal de notification.

Extension GA
az grafana notification-channel test

Testez un canal de notification.

Extension GA
az grafana notification-channel update

Mettez à jour un canal de notification.

Extension GA
az grafana restore

Restaurez une instance Azure Managed Grafana à partir d’une archive.

Extension Aperçu
az grafana service-account

Commandes pour gérer les comptes de service.

Extension GA
az grafana service-account create

Créez un compte de service.

Extension GA
az grafana service-account delete

Supprimez un compte de service.

Extension GA
az grafana service-account list

Répertorier les comptes de service existants.

Extension GA
az grafana service-account show

Obtenez les détails d’un compte de service.

Extension GA
az grafana service-account token

Commandes pour gérer les jetons de compte de service.

Extension GA
az grafana service-account token create

Créez un jeton de compte de service.

Extension GA
az grafana service-account token delete

Supprimez un jeton de compte de service.

Extension GA
az grafana service-account token list

Répertorier les jetons de compte de service existants.

Extension GA
az grafana service-account update

Mettez à jour un compte de service.

Extension GA
az grafana show

Afficher les détails d’une instance Azure Managed Grafana.

Extension GA
az grafana update

Mettez à jour une instance Azure Managed Grafana.

Extension GA
az grafana user

Commandes pour gérer les utilisateurs d’une instance.

Extension GA
az grafana user actual-user

Obtenez les détails de l’utilisateur actuel.

Extension GA
az grafana user list

Répertorier les utilisateurs.

Extension GA
az grafana user show

Obtenez les détails d’un utilisateur.

Extension GA

az grafana backup

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

Sauvegardez le contenu d’une instance Azure Managed Grafana dans une archive.

az grafana backup --name
                  [--components {annotations, dashboards, datasources, folders, snapshots}]
                  [--directory]
                  [--folders-to-exclude]
                  [--folders-to-include]
                  [--resource-group]

Exemples

tableaux de bord de sauvegarde sous 2 dossiers (les sources de données sont incluses pour activer le remapping de noms lors de la restauration de tableaux de bord dans un autre espace de travail)

az grafana backup -g MyResourceGroup -n MyGrafana -d c:\temp --folders-to-include "Prod" "Compute Gateway" --components datasources dashboards folders

tableaux de bord de sauvegarde et ignorer quelques dossiers

az grafana backup -g MyResourceGroup -n MyGrafana -d c:\temp  --folders-to-exclude General "Azure Monitor" --components datasources dashboards folders

Paramètres obligatoires

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--components -c

Types d’artefacts Grafana à sauvegarder.

valeurs acceptées: annotations, dashboards, datasources, folders, snapshots
--directory -d

Répertoire pour sauvegarder des artefacts Grafana.

--folders-to-exclude -e

Dossiers à exclure dans la sauvegarde ou la synchronisation.

--folders-to-include -i

Dossiers à inclure dans la sauvegarde ou la synchronisation.

--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 create

Créez une instance Azure Managed Grafana.

az grafana create --name
                  --resource-group
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--location]
                  [--principal-ids]
                  [--principal-types {Group, ServicePrincipal, User}]
                  [--skip-role-assignments {false, true}]
                  [--skip-system-assigned-identity {false, true}]
                  [--tags]
                  [--zone-redundancy {Disabled, Enabled}]

Paramètres obligatoires

--name -n

Nom d’Azure Managed Grafana.

--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 facultatifs

--deterministic-outbound-ip -i

Si cette option est activée, l’espace de travail Grafana dispose d’adresses IP de sortie fixes que vous pouvez utiliser dans le pare-feu des sources de données. Valeur par défaut : Désactivé.

valeurs acceptées: Disabled, Enabled
--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

--principal-ids

Ids d’objet Azure AD séparés par l’espace pour les utilisateurs, les groupes, etc., à créer en tant que Administration s Grafana. Une fois fourni, l’interface CLI ne rend pas l’utilisateur connecté actuel en tant que Administration Grafana.

--principal-types

Types de principaux Azure AD séparés par l’espace à associer à --principal-ids.

valeurs acceptées: Group, ServicePrincipal, User
--skip-role-assignments

Ne créez pas d’attributions de rôle pour l’identité managée et l’utilisateur de connexion actuel.

valeurs acceptées: false, true
valeur par défaut: False
--skip-system-assigned-identity -s

N’activez pas l’identité affectée par le système.

valeurs acceptées: false, true
valeur par défaut: False
--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--zone-redundancy

Indique si la redondance de zone doit être activée ou non. Valeur par défaut : Désactivé.

valeurs acceptées: Disabled, Enabled
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 delete

Supprimez une instance Azure Managed Grafana.

az grafana delete --name
                  [--resource-group]
                  [--yes]

Paramètres obligatoires

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--resource-group -g

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

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
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 list

Répertorier les instances Azure Managed Grafana.

az grafana list [--resource-group]

Paramètres facultatifs

--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 restore

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

Restaurez une instance Azure Managed Grafana à partir d’une archive.

az grafana restore --archive-file
                   --name
                   [--components {annotations, dashboards, datasources, folders, snapshots}]
                   [--remap-data-sources {false, true}]
                   [--resource-group]

Exemples

Restaurer des tableaux de bord. S’ils sont sous dossiers, incluez « dossiers » dans la liste des composants ; utilisez « --remap-data-sources » pour que l’interface CLI met à jour les tableaux de bord pour qu’ils pointent vers les mêmes sources de données au niveau de l’espace de travail cible

az grafana restore -g MyResourceGroup -n MyGrafana --archive-file backup\dashboards\ServiceHealth-202307051036.tar.gz --components dashboards folders --remap-data-sources

Paramètres obligatoires

--archive-file -a

Archiver pour restaurer des artefacts Grafana à partir de.

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--components -c

Types d’artefacts Grafana à sauvegarder.

valeurs acceptées: annotations, dashboards, datasources, folders, snapshots
--remap-data-sources -r

Lors de la restauration, mettez à jour les tableaux de bord pour référencer les sources de données définies au niveau de l’espace de travail de destination via la correspondance de noms.

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 show

Afficher les détails d’une instance Azure Managed Grafana.

az grafana show --name
                [--resource-group]

Paramètres obligatoires

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--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 update

Mettez à jour une instance Azure Managed Grafana.

az grafana update --name
                  [--api-key {Disabled, Enabled}]
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--from-address]
                  [--from-name]
                  [--host]
                  [--major-version]
                  [--password]
                  [--public-network-access {Disabled, Enabled}]
                  [--resource-group]
                  [--skip-verify {false, true}]
                  [--smtp {Disabled, Enabled}]
                  [--start-tls-policy {MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS}]
                  [--tags]
                  [--user]

Exemples

désactiver l’accès au réseau public

az grafana update -g MyResourceGroup -n MyGrafana --public-network-access disabled

activer la notification par courrier via le relais SMTP sevice de mailgun

az grafana update -g MyResourceGroup -n MyGrafana --smtp enabled --from-address johndoe@outlook.com --from-name john --host "smtp.mailgun.org:587" --user "postmaster@sandbox12345.mailgun.org" --password "password" --start-tls-policy OpportunisticStartTLS --skip-verify true

Paramètres obligatoires

--name -n

Nom d’Azure Managed Grafana.

Paramètres facultatifs

--api-key --service-account

Si cette option est activée, vous pourrez configurer les clés d’API et les comptes de service Grafana.

valeurs acceptées: Disabled, Enabled
--deterministic-outbound-ip -i

Si cette option est activée, l’espace de travail Grafana dispose d’adresses IP de sortie fixes que vous pouvez utiliser dans le pare-feu des sources de données.

valeurs acceptées: Disabled, Enabled
--from-address

Adresse utilisée lors de l’envoi d’e-mails.

--from-name

Nom à utiliser lors de l’envoi d’e-mails.

--host

URL du serveur SMTP (port inclus).

--major-version

Numéro de version majeure de Grafana.

--password

Mot de passe utilisateur du serveur SMTP.

--public-network-access -p

Autoriser l’accès au réseau public.

valeurs acceptées: Disabled, Enabled
--resource-group -g

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

--skip-verify

Ignorez la vérification du protocole SSL pour le serveur SMTP.

valeurs acceptées: false, true
--smtp

Autoriser Grafana à envoyer un e-mail.

valeurs acceptées: Disabled, Enabled
--start-tls-policy

Stratégie TLS.

valeurs acceptées: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS
--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--user

Nom d’utilisateur du serveur SMTP.

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.