Partager via

az iot central diagnostics

  • Préversion

Note

Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.67.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une az iot central diagnostics commande. Apprenez-en davantage sur les extensions.

Ce groupe de commandes est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Effectuez des diagnostics au niveau de l’application et de l’appareil.

Commandes

Nom Description Type État
az iot central diagnostics monitor-events

Affichez les messages de télémétrie de l’appareil envoyés à l’application IoT Central.

 Extension Preview
az iot central diagnostics monitor-properties

Affichez les propriétés souhaitées et signalées envoyées à/partir de l’application IoT Central.

 Extension Preview
az iot central diagnostics registration-summary

Affichez le résumé de l’inscription de tous les appareils d’une application.

 Extension Preview
az iot central diagnostics validate-messages

Validez les messages envoyés au hub IoT pour une application IoT Central.

 Extension Preview
az iot central diagnostics validate-properties

Validez les propriétés signalées envoyées à l’application IoT Central.

 Extension Preview

az iot central diagnostics monitor-events

Préversion

Le groupe de commandes « diagnostics centraux iot » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Affichez les messages de télémétrie de l’appareil envoyés à l’application IoT Central.

Affiche les données de télémétrie envoyées à l’application IoT Central. Par défaut, il affiche toutes les données envoyées par tous les appareils. Utilisez le paramètre --device-id pour filtrer sur un appareil spécifique.

az iot central diagnostics monitor-events --app-id
                                          [--central-api-uri --central-dns-suffix]
                                          [--cg --consumer-group]
                                          [--device-id]
                                          [--enqueued-time --et]
                                          [--module-id]
                                          [--properties --props {all, anno, app, sys}]
                                          [--repair {false, true}]
                                          [--timeout --to]
                                          [--token]
                                          [--yes {false, true}]

Exemples

Utilisation de base

az iot central diagnostics monitor-events --app-id {app_id}

Utilisation de base lors du filtrage sur l’appareil cible

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id}

Utilisation de base lors du filtrage des appareils ciblés avec un caractère générique dans l’ID

az iot central diagnostics monitor-events --app-id {app_id} -d Device*d

Utilisation de base lors du filtrage sur le module.

az iot central diagnostics monitor-events --app-id {app_id} -m {module_id}

Utilisation de base lors du filtrage des modules ciblés avec un caractère générique dans l’ID

az iot central diagnostics monitor-events --app-id {app_id} -m Module*

Filtrez l’appareil et spécifiez un groupe de consommateurs Event Hub à lier.

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --cg {consumer_group_name}

Recevoir des annotations de message (en-têtes de message)

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno

Recevoir des annotations de message + propriétés système. N’oubliez jamais de sortir.

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno sys --timeout 0

Recevoir tous les attributs de message de tous les messages de l’appareil

az iot central diagnostics monitor-events --app-id {app_id} --props all

Recevoir tous les messages et analyser la charge utile des messages en tant que JSON

az iot central diagnostics monitor-events --app-id {app_id} --output json

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
Valeur par défaut: azureiotcentral.com
--cg --consumer-group -c

Spécifiez le groupe de consommateurs à utiliser lors de la connexion au point de terminaison event Hub.

Propriété Valeur
Valeur par défaut: $Default
--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

--enqueued-time --et -e

Indique l’heure à utiliser comme point de départ pour lire les messages à partir des partitions. Les unités sont des millisecondes depuis l’époque unix. Si aucun temps n’est indiqué « maintenant » est utilisé.

--module-id -m

ID de module IoT Edge si le type d’appareil est IoT Edge.

--properties --props -p

Indiquez les propriétés de message clé à générer. sys = propriétés système, application = propriétés de l’application, anno = annotations.

Propriété Valeur
Valeurs acceptées: all, anno, app, sys
--repair -r

Réinstallez la dépendance uamqp compatible avec la version de l’extension. Valeur par défaut : false.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--timeout --to -t

Nombre maximal de secondes pour maintenir la connexion sans recevoir de message. Utilisez 0 pour l’infini.

Propriété Valeur
Valeur par défaut: 300
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. En savoir plus sur https://aka.ms/iotcentraldocsapi.

--yes -y

Ignorez les invites de l’utilisateur. Indique l’acceptation de l’action. Utilisé principalement pour les scénarios d’automatisation. Valeur par défaut : false.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az iot central diagnostics monitor-properties

Préversion

Le groupe de commandes « diagnostics centraux iot » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Affichez les propriétés souhaitées et signalées envoyées à/partir de l’application IoT Central.

Interroge le jumeau d’appareil de central et le compare aux dernières propriétés d’analyse du jumeau d’appareil à partir du jumeau d’appareil et détecte si des modifications ont été apportées à un sous-ensemble d’impression des propriétés qui ont été modifiées dans l’intervalle d’interrogation.

az iot central diagnostics monitor-properties --app-id
                                              --device-id
                                              [--central-api-uri --central-dns-suffix]
                                              [--token]

Exemples

Utilisation de base

az iot central diagnostics monitor-properties --app-id {app_id} -d {device_id}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. En savoir plus sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az iot central diagnostics registration-summary

Préversion

Le groupe de commandes « diagnostics centraux iot » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Affichez le résumé de l’inscription de tous les appareils d’une application.

Remarque : cette commande peut prendre beaucoup de temps pour retourner si votre application contient beaucoup d’appareils.

az iot central diagnostics registration-summary --app-id
                                                [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                                [--central-api-uri --central-dns-suffix]
                                                [--token]

Exemples

Résumé de l’inscription

az iot central diagnostics registration-summary --app-id {appid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Propriété Valeur
Valeur par défaut: 2022-07-31
Valeurs acceptées: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. En savoir plus sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az iot central diagnostics validate-messages

Préversion

Le groupe de commandes « diagnostics centraux iot » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Validez les messages envoyés au hub IoT pour une application IoT Central.

Effectue des validations sur les messages de télémétrie et signale les données qui ne sont pas modélisées dans le modèle d’appareil ou les données où le type de données ne correspond pas à ce qui est défini dans le modèle d’appareil.

az iot central diagnostics validate-messages --app-id
                                             [--central-api-uri --central-dns-suffix]
                                             [--cg --consumer-group]
                                             [--device-id]
                                             [--dr --duration]
                                             [--enqueued-time --et]
                                             [--max-messages --mm]
                                             [--minimum-severity {error, info, warning}]
                                             [--module-id]
                                             [--properties --props {all, anno, app, sys}]
                                             [--repair {false, true}]
                                             [--style {csv, json, scroll}]
                                             [--timeout --to]
                                             [--token]
                                             [--yes {false, true}]

Exemples

Utilisation de base

az iot central diagnostics validate-messages --app-id {app_id}

Erreurs de sortie détectées

az iot central diagnostics validate-messages --app-id {app_id} --style scroll

Utilisation de base lors du filtrage sur l’appareil cible

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id}

Utilisation de base lors du filtrage des appareils ciblés avec un caractère générique dans l’ID

az iot central diagnostics validate-messages --app-id {app_id} -d Device*

Utilisation de base lors du filtrage sur le module.

az iot central diagnostics validate-messages --app-id {app_id} -m {module_id}

Utilisation de base lors du filtrage des modules ciblés avec un caractère générique dans l’ID

az iot central diagnostics validate-messages --app-id {app_id} -m Module*

Filtrez l’appareil et spécifiez un groupe de consommateurs Event Hub à lier.

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id} --cg {consumer_group_name}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
Valeur par défaut: azureiotcentral.com
--cg --consumer-group -c

Spécifiez le groupe de consommateurs à utiliser lors de la connexion au point de terminaison event Hub.

Propriété Valeur
Valeur par défaut: $Default
--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

--dr --duration

Durée maximale de réception des messages de l’appareil cible avant la fin de la connexion. Utilisez 0 pour l’infini.

Propriété Valeur
Valeur par défaut: 300
--enqueued-time --et -e

Indique l’heure à utiliser comme point de départ pour lire les messages à partir des partitions. Les unités sont des millisecondes depuis l’époque unix. Si aucun temps n’est indiqué « maintenant » est utilisé.

--max-messages --mm

Nombre maximal de messages à recevoir de l’appareil cible avant la fin de la connexion. Utilisez 0 pour l’infini.

Propriété Valeur
Valeur par défaut: 10
--minimum-severity

Gravité minimale du problème requis pour la création de rapports.

Propriété Valeur
Valeur par défaut: warning
Valeurs acceptées: error, info, warning
--module-id -m

ID de module IoT Edge si le type d’appareil est IoT Edge.

--properties --props -p

Indiquez les propriétés de message clé à générer. sys = propriétés système, application = propriétés de l’application, anno = annotations.

Propriété Valeur
Valeurs acceptées: all, anno, app, sys
--repair -r

Réinstallez la dépendance uamqp compatible avec la version de l’extension. Valeur par défaut : false.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--style

Indiquez les styles de sortiecroll = fournir des erreurs à mesure qu’elles arrivent, json = synthétiser les résultats au format json, csv = résumer les résultats au format csv.

Propriété Valeur
Valeur par défaut: scroll
Valeurs acceptées: csv, json, scroll
--timeout --to -t

Nombre maximal de secondes pour maintenir la connexion sans recevoir de message. Utilisez 0 pour l’infini.

Propriété Valeur
Valeur par défaut: 300
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. En savoir plus sur https://aka.ms/iotcentraldocsapi.

--yes -y

Ignorez les invites de l’utilisateur. Indique l’acceptation de l’action. Utilisé principalement pour les scénarios d’automatisation. Valeur par défaut : false.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az iot central diagnostics validate-properties

Préversion

Le groupe de commandes « diagnostics centraux iot » est en préversion et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Validez les propriétés signalées envoyées à l’application IoT Central.

Effectue des validations sur les mises à jour des propriétés signalées :

  1. Avertissement : propriétés envoyées par l’appareil qui ne sont pas modélisées dans le centre.
  2. Avertissement : les propriétés avec le même nom déclaré dans plusieurs interfaces doivent avoir le nom de l’interface inclus dans le cadre de la mise à jour de propriété.
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri --central-dns-suffix]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

Exemples

Utilisation de base

az iot central diagnostics validate-properties --app-id {app_id} -d {device_id}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
Valeur par défaut: azureiotcentral.com
--minimum-severity

Gravité minimale du problème requis pour la création de rapports.

Propriété Valeur
Valeur par défaut: warning
Valeurs acceptées: error, info, warning
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. En savoir plus sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False