az monitor app-insights workbook

Remarque

Cette référence fait partie de l’extension Application-Insights pour Azure CLI (version 2.55.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande de classeur app-insights az monitor. En savoir plus sur les extensions.

Gérer le classeur App-Insights.

Commandes

Nom	Description	Type	Statut
az monitor app-insights workbook create	Créer un classeur	Extension	GA
az monitor app-insights workbook delete	Supprimez un classeur.	Extension	GA
az monitor app-insights workbook identity	Gérer l’idnéité du classeur.	Extension	GA
az monitor app-insights workbook identity assign	Affecter des identités.	Extension	GA
az monitor app-insights workbook identity remove	Supprimez les identités.	Extension	GA
az monitor app-insights workbook list	Répertorier tous les classeurs définis dans un groupe de ressources et une catégorie spécifiés.	Extension	GA
az monitor app-insights workbook revision	Gérer la révision du classeur.	Extension	GA
az monitor app-insights workbook revision list	Répertoriez les révisions du classeur.	Extension	GA
az monitor app-insights workbook revision show	Afficher la révision du classeur.	Extension	GA
az monitor app-insights workbook show	Afficher un classeur unique par son nom de ressource.	Extension	GA
az monitor app-insights workbook update	Mettez à jour un classeur.	Extension	GA

az monitor app-insights workbook create

Créer un classeur

az monitor app-insights workbook create --name
                                        --resource-group
                                        [--category]
                                        [--description]
                                        [--display-name]
                                        [--kind {shared}]
                                        [--location]
                                        [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--mi-user-assigned]
                                        [--serialized-data]
                                        [--source-id]
                                        [--storage-uri]
                                        [--tags]
                                        [--version]

Exemples

Créer un classeur

az monitor app-insights workbook create -n 00000000-0000-0000-0000-000000000000 -g rg --serialized-data mydata --kind shared --category workbook  --display-name workbookname

Paramètres obligatoires

--name --resource-name -n

Nom de la ressource de classeur. La valeur doit être un UUID.

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

--category

Catégorie de classeur, telle que définie par l’utilisateur au moment de la création.

--description

Description du classeur.

--display-name

Nom défini par l’utilisateur (nom complet) du classeur.

--kind

Type de classeur. Seule la valeur valide est partagée.

valeurs acceptées: shared

--location -l

Emplacement géographique où la ressource se trouve quand elle n’est pas spécifiée, l’emplacement du groupe de ressources sera utilisé.

--mi-system-assigned

Activez l’identité affectée par le système.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes

--mi-user-assigned

ID de ressource séparés par l’espace pour ajouter des identités affectées par l’utilisateur. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--serialized-data

Configuration de ce classeur particulier. Les données de configuration sont une chaîne contenant un JSON valide.

--source-id

ID de ressource Azure qui récupère tous les classeurs liés.

--storage-uri

ResourceId vers le compte de stockage lorsque vous utilisez votre propre stockage.

--tags

Balises de ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--version

Format de version du schéma de classeur, tel que « Notebook/1.0 », qui doit correspondre au classeur dans serializedData.

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 monitor app-insights workbook delete

Supprimez un classeur.

az monitor app-insights workbook delete [--ids]
                                        [--name]
                                        [--resource-group]
                                        [--subscription]
                                        [--yes]

Exemples

Supprimer un classeur

az monitor app-insights workbook delete -n 00000000-0000-0000-0000-000000000000 -g wktest

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name --resource-name -n

Nom de la ressource de classeur. La valeur doit être un UUID.

--resource-group -g

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

--subscription

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

--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 monitor app-insights workbook list

Répertorier tous les classeurs définis dans un groupe de ressources et une catégorie spécifiés.

az monitor app-insights workbook list --category {TSG, performance, retention, workbook}
                                      [--can-fetch-content {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--max-items]
                                      [--next-token]
                                      [--resource-group]
                                      [--source-id]
                                      [--tags]

Exemples

Répertorier le classeur

az monitor app-insights workbook list -g rg --category workbook

Paramètres obligatoires

--category

Catégorie de classeur à retourner.

valeurs acceptées: TSG, performance, retention, workbook

Paramètres facultatifs

--can-fetch-content

Indicateur indiquant si le contenu complet de chaque classeur applicable doit être retourné ou non. Si la valeur est false, renvoyez uniquement le contenu récapitulative des classeurs.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token l’argument d’une commande suivante.

--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

--resource-group -g

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

--source-id

ID de ressource Azure qui récupère tous les classeurs liés.

--tags

Balises présentes sur chaque classeur retourné. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

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 monitor app-insights workbook show

Afficher un classeur unique par son nom de ressource.

az monitor app-insights workbook show [--can-fetch-content {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Exemples

Afficher le classeur

az monitor app-insights workbook show -n 00000000-0000-0000-0000-000000000000 -g wktest

Paramètres facultatifs

--can-fetch-content

Indicateur indiquant si le contenu complet de chaque classeur applicable doit être retourné ou non. Si la valeur est false, renvoyez uniquement le contenu récapitulative des classeurs.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name --resource-name -n

Nom de la ressource de classeur. La valeur doit être un UUID.

--resource-group -g

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

--subscription

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

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 monitor app-insights workbook update

Mettez à jour un classeur.

az monitor app-insights workbook update [--add]
                                        [--category]
                                        [--description]
                                        [--display-name]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--ids]
                                        [--kind {shared}]
                                        [--name]
                                        [--remove]
                                        [--resource-group]
                                        [--serialized-data]
                                        [--set]
                                        [--source-id]
                                        [--storage-uri]
                                        [--subscription]
                                        [--tags]
                                        [--version]

Exemples

Mettre à jour le classeur

az monitor app-insights workbook update -n 00000000-0000-0000-0000-000000000000 -g rg --tags tag=test

Paramètres facultatifs

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string ou JSON string>.

--category

Catégorie de classeur, telle que définie par l’utilisateur au moment de la création.

--description

Description du classeur.

--display-name

Nom défini par l’utilisateur (nom complet) du classeur.

--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--kind

Type de classeur. Seule la valeur valide est partagée.

valeurs acceptées: shared

--name --resource-name -n

Nom de la ressource de classeur. La valeur doit être un UUID.

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--serialized-data

Configuration de ce classeur particulier. Les données de configuration sont une chaîne contenant un JSON valide.

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=.

--source-id

ID de ressource Azure qui récupère tous les classeurs liés.

--storage-uri

ResourceId vers le compte de stockage lorsque vous utilisez votre propre stockage.

--subscription

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

--tags

Balises de ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--version

Format de version du schéma de classeur, tel que « Notebook/1.0 », qui doit correspondre au classeur dans serializedData.

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.