az iot device c2d-message

  • Référence

Remarque

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

Commandes de messagerie cloud à appareil.

Commandes

Nom Description Type État
az iot device c2d-message abandon

Abandonner un message cloud-à-appareil.

 Extension GA
az iot device c2d-message complete

Terminez un message cloud-à-appareil.

 Extension GA
az iot device c2d-message purge

Videz la file d’attente de messages cloud-à-appareil pour un appareil cible.

 Extension GA
az iot device c2d-message receive

Recevoir un message cloud-à-appareil.

 Extension GA
az iot device c2d-message reject

Rejeter ou deadletter un message cloud-à-appareil.

 Extension GA
az iot device c2d-message send

Envoyez un message cloud-à-appareil.

 Extension GA

az iot device c2d-message abandon

Abandonner un message cloud-à-appareil.

az iot device c2d-message abandon --device-id
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

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.

az iot device c2d-message complete

Terminez un message cloud-à-appareil.

az iot device c2d-message complete --device-id
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

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.

az iot device c2d-message purge

Videz la file d’attente de messages cloud-à-appareil pour un appareil cible.

az iot device c2d-message purge --device-id
                                [--hub-name]
                                [--login]
                                [--resource-group]

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 device c2d-message receive

Recevoir un message cloud-à-appareil.

Le corps du message reçu est décodé uniquement lorsque son encodage de contenu est défini sur « utf-8 », « utf-16 » ou « utf-32 ». La charge utile du message s’affiche en tant que {{charge utile non décodable}} lorsque l’encodage du contenu n’est pas défini sur l’un des éléments ci-dessus ou ne parvient pas à décoder même lorsque l’encodage du contenu est défini sur l’un des éléments ci-dessus.

Remarque : un seul argument de message [--complete, --reject, --abandon] est accepté.

az iot device c2d-message receive --device-id
                                  [--abandon {false, true}]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout]
                                  [--login]
                                  [--reject {false, true}]
                                  [--resource-group]

Exemples

Utilisation de base

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group}

Recevoir un message et définir un délai d’expiration de verrouillage de 30 secondes pour ce message

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --lt {30}

Recevoir un message et l’envoyer comme « terminé » une fois qu’il a été reçu

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --complete

Recevoir un message et le rejeter une fois qu’il a été reçu

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --reject

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

Paramètres facultatifs

--abandon

Abandonnez le message cloud-à-appareil après réception.

Valeurs acceptées: false, true
Valeur par défaut: False
--complete

Terminez le message cloud-à-appareil après réception.

Valeurs acceptées: false, true
Valeur par défaut: False
--hub-name -n

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

--lock-timeout --lt

Spécifie la durée pendant laquelle un message sera invisible pour d’autres appels de réception.

Valeur par défaut: 60
--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.

--reject

Rejeter le message cloud-à-appareil après réception.

Valeurs acceptées: false, true
Valeur par défaut: False
--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 device c2d-message reject

Rejeter ou deadletter un message cloud-à-appareil.

az iot device c2d-message reject --device-id
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

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.

az iot device c2d-message send

Envoyez un message cloud-à-appareil.

Cette commande s’appuie et peut installer le package Cython dépendant (uamqp) lors de la première exécution. https://github.com/Azure/azure-uamqp-python

Remarque : l’encodage du contenu est défini par défaut sur utf-8. La commande envoie le corps du message avec une action d’encodage lorsque la propriété d’encodage de contenu est utf-8, utf-16 ou utf-32. Si la valeur d’encodage de contenu n’est pas l’une de ces valeurs, la propriété est toujours envoyée sans aucune action d’encodage effectuée.

Lors de l’envoi d’un corps de message binaire, le contenu doit être fourni à partir d’un fichier (via --data-file-path) et le type de contenu doit être défini sur application/octet-stream.

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--data-file-path]
                               [--expiry]
                               [--hub-name]
                               [--login]
                               [--message-id]
                               [--properties]
                               [--repair {false, true}]
                               [--resource-group]
                               [--uid]
                               [--wait {false, true}]
                               [--yes {false, true}]

Exemples

Utilisation de base avec le corps du message par défaut

az iot device c2d-message send -d {device_id} -n {iothub_name}

Envoyez un message cloud-à-appareil avec des données et des propriétés personnalisées.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data 'Hello World' --props 'key0=value0;key1=value1'

Envoyer un message C2D et attendre l’accusé de réception de l’appareil

az iot device c2d-message send -d {device_id} -n {iothub_name} --ack full --wait

Envoyez un message C2D au format binaire à partir d’un fichier.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/octet-stream'

Envoyez un message C2D au format JSON à partir d’un fichier.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/json'

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

Paramètres facultatifs

--ack

Demandez la remise de commentaires par message concernant l’état final de ce message. La description des valeurs ack est la suivante. Positif : si le message c2d atteint l’état Terminé, IoT Hub génère un message de commentaires. Négatif : si le message c2d atteint l’état de lettres mortes, IoT Hub génère un message de commentaires. Complet : IoT Hub génère un message de commentaires dans les deux cas. Par défaut, aucun ack n’est demandé.

Valeurs acceptées: full, negative, positive
--auth-type

Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type=<auth-type-value>de .

Valeurs acceptées: key, login
Valeur par défaut: key
--ce --content-encoding

Encodage du corps du message C2D.

Valeur par défaut: utf-8
--cid --correlation-id

ID de corrélation associé au message C2D.

--content-type --ct

Type de contenu pour le corps du message C2D.

--da --data

Corps du message. Fournissez du texte ou du json brut.

Valeur par défaut: Ping from Az CLI IoT Extension
--data-file-path --dfp
Préversion

Indiquez le chemin d’accès au fichier pour la charge utile du corps du message. Notez que la charge utile doit être envoyée au format binaire, définissez le type de contenu sur application/octet-stream.

--expiry --expiry-time-utc

Les unités sont des millisecondes depuis l’époque unix. Si aucune heure n’est indiquée, la durée de vie du message C2D IoT Hub par défaut 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.

--message-id --mid

ID du message C2D. Si aucun ID de message n’est fourni, un UUID est généré.

--properties --props -p

Conteneur de propriétés de message dans des paires clé-valeur au format suivant : a=b ; c=d.

--repair -r

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

Valeurs acceptées: false, true
Valeur par défaut: False
--resource-group -g

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

--uid --user-id

Message C2D, propriété ID utilisateur.

--wait -w

Si l’opération d’envoi c2d se bloque jusqu’à ce que les commentaires de l’appareil aient été reçus.

Valeurs acceptées: false, true
Valeur par défaut: False
--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.

Valeurs acceptées: false, true
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.