az iot central device command

  • Référence

Remarque

Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.37.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande de commande d’appareil central az iot. En savoir plus sur les extensions.

Exécutez des commandes d’appareil.

Commandes

Nom Description Type Statut
az iot central device command history

Obtenez les détails de la dernière demande de commande et de la réponse envoyées à l’appareil.

 Extension GA
az iot central device command run

Exécutez une commande sur un appareil et affichez la réponse associée. Ne surveille pas les mises à jour des propriétés que la commande peut effectuer.

 Extension GA

az iot central device command history

Obtenez les détails de la dernière demande de commande et de la réponse envoyées à l’appareil.

Répertorie la demande et la réponse de commande les plus récentes envoyées à l’appareil à partir d’IoT Central. Toute mise à jour effectuée par l’appareil sur les propriétés de l’appareil en raison de l’exécution de la commande n’est pas incluse dans la réponse.

az iot central device command history --app-id
                                      --cn
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--co]
                                      [--interface-id]
                                      [--mn]
                                      [--token]

Exemples

Afficher la réponse de commande

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

Afficher la réponse de commande du composant

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

Afficher la réponse de commande du composant module

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

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.

--cn --command-name

Nom de commande spécifié dans le modèle d’appareil. Le nom de la commande peut être différent du nom complet de la commande.

--device-id -d

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

Paramètres facultatifs

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

valeurs acceptées: 2022-06-30-preview, 2022-07-31
valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

valeur par défaut: azureiotcentral.com
--co --component-name

Nom du composant d’appareil.

--interface-id -i

Nom de l’interface/composant tel que spécifié dans le modèle d’appareil. Vous pouvez le trouver en accédant au modèle d’appareil et en affichant l’identité de l’interface/composant sous la fonctionnalité d’appareil correspondante.

--mn --module-name

Nom du module d’appareil.

--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. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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 iot central device command run

Exécutez une commande sur un appareil et affichez la réponse associée. Ne surveille pas les mises à jour des propriétés que la commande peut effectuer.

--content peut être inline json ou chemin d’accès de fichier.

az iot central device command run --app-id
                                  --cn
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--interface-id]
                                  [--mn]
                                  [--token]

Exemples

Exécutez la commande avec une charge utile inline. La charge utile doit être sous « requête » dans la chaîne json

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

Commande Run courte avec chemin de charge utile json.

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

Commande Exécuter le composant.

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

Exécuter la commande du composant de module.

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

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.

--cn --command-name

Nom de commande spécifié dans le modèle d’appareil. Le nom de la commande peut être différent du nom complet de la commande.

--content -k

Configuration de la demande. Fournissez le chemin d’accès au fichier JSON ou au fichier JSON brut en chaîne. [Exemple de chemin de fichier : ./path/to/file.json] [Exemple JSON stringified : {'a' : 'b'}].

--device-id -d

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

Paramètres facultatifs

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

valeurs acceptées: 2022-06-30-preview, 2022-07-31
valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

valeur par défaut: azureiotcentral.com
--co --component-name

Nom du composant d’appareil.

--interface-id -i

Nom de l’interface/composant tel que spécifié dans le modèle d’appareil. Vous pouvez le trouver en accédant au modèle d’appareil et en affichant l’identité de l’interface/composant sous la fonctionnalité d’appareil correspondante.

--mn --module-name

Nom du module d’appareil.

--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. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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.