az iot hub digital-twin

  • 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 az iot hub digital-twin . En savoir plus sur les extensions.

Manipuler et interagir avec le jumeau numérique d’un appareil IoT Hub.

Commandes

Nom Description Type Statut
az iot hub digital-twin invoke-command

Appelez une commande de niveau racine ou composant d’un appareil de jumeau numérique.

 Extension GA
az iot hub digital-twin show

Afficher le jumeau numérique d’un appareil IoT Hub.

 Extension GA
az iot hub digital-twin update

Mettez à jour les propriétés en lecture-écriture d’un appareil de jumeau numérique via la spécification de correctif JSON.

 Extension GA

az iot hub digital-twin invoke-command

Appelez une commande de niveau racine ou composant d’un appareil de jumeau numérique.

az iot hub digital-twin invoke-command --cn
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout]

Exemples

En règle générale, appelez la commande qui prend une charge utile qui inclut certaines propriétés à l’aide de JSON inline.

az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'

Appeler la commande de niveau racine « reboot » qui prend une charge utile nommée « delay » conforme au modèle DTDL https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.

az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5

Appelez la commande « getMaxMinReport » sur le composant « thermostat1 » qui n’accepte aucune entrée.

az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1

Paramètres obligatoires

--cn --command-name

Nom de la commande jumeau numérique.

--device-id -d

ID d’appareil cible.

Paramètres facultatifs

--component-path

Chemin du composant jumeau numérique. Par exemple : thermostat1.

--connect-timeout --cto

Intervalle maximal de temps, en secondes, que IoT Hub tente de se connecter à l’appareil.

--hub-name -n

Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.

--login -l

Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.

--payload

Entrée de charge utile JSON pour la commande. Fournissez le chemin d’accès au fichier ou json inline.

valeur par défaut: {}
--resource-group -g

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

--response-timeout --rto

Intervalle maximal de temps, en secondes, que la commande de jumeau numérique attend le résultat.

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 hub digital-twin show

Afficher le jumeau numérique d’un appareil IoT Hub.

az iot hub digital-twin show --device-id
                             [--hub-name]
                             [--login]
                             [--resource-group]

Exemples

Afficher le jumeau numérique de l’appareil cible.

az iot hub digital-twin show -n {iothub_name} -d {device_id}

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

Paramètres facultatifs

--hub-name -n

Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.

--login -l

Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.

--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 iot hub digital-twin update

Mettez à jour les propriétés en lecture-écriture d’un appareil de jumeau numérique via la spécification de correctif JSON.

Actuellement, les opérations sont limitées à l’ajout, au remplacement et à la suppression.

az iot hub digital-twin update --device-id
                               --json-patch
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Exemples

Mettez à jour un jumeau numérique via la spécification des correctifs JSON.

az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'

Mettez à jour un jumeau numérique via la spécification des correctifs JSON.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
  {"op":"remove", "path":"/thermostat1/targetTemperature"},
  {"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'

Mettez à jour une propriété de jumeau numérique via la spécification de correctif JSON définie dans un fichier.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

--json-patch --patch

Spécification de mise à jour décrite par JSON-patch. Les opérations sont limitées à l’ajout, au remplacement et à la suppression. Fournissez le chemin d’accès au fichier ou json inline.

Paramètres facultatifs

--etag -e

Étiquette d’entité ou etag correspondant au dernier état de la ressource. Si aucun etag n’est fourni, la valeur '*' est utilisée.

--hub-name -n

Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.

--login -l

Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.

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