az iot hub route

  • Déprécié
  • Référence

Ce groupe de commandes a été déconseillé et sera supprimé dans une prochaine version. Utilisez le groupe de commandes d’itinéraire de message d’extension IoT (azure-iot) (az iot hub message-route) à la place.

Gérer les itinéraires d’un IoT Hub.

Commandes

Nom Description Type Statut
az iot hub route create

Créez un itinéraire dans IoT Hub.

 Core Déprécié
az iot hub route delete

Supprimez tout ou itinéraire mentionné pour votre IoT Hub.

 Core Déprécié
az iot hub route list

Obtenez tous les itinéraires dans IoT Hub.

 Core Déprécié
az iot hub route show

Obtenez des informations sur l’itinéraire dans IoT Hub.

 Core Déprécié
az iot hub route test

Testez tous les itinéraires ou itinéraires mentionnés dans IoT Hub.

 Core Déprécié
az iot hub route update

Mettez à jour un itinéraire dans IoT Hub.

 Core Déprécié

az iot hub route create

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « iot hub route » est déconseillé et sera supprimé dans une prochaine version. Utilisez le groupe de commandes d’itinéraire de message d’extension IoT (azure-iot) (az iot hub message-route) à la place.

Créez un itinéraire dans IoT Hub.

Créez un itinéraire pour envoyer une source de données et une condition spécifiques à un point de terminaison souhaité.

az iot hub route create --en
                        --hub-name
                        --name
                        --source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                        [--condition]
                        [--enabled {false, true}]
                        [--resource-group]

Exemples

Créez un itinéraire « R1 ».

az iot hub route create -g MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --source DeviceMessages --route-name R1

Créez un itinéraire « R1 » avec tous les paramètres.

az iot hub route create -g MyResourceGroup --hub-name MyIotHub --endpoint-name E2 --source DeviceMessages --route-name R1 --condition true --enabled true

Paramètres obligatoires

--en --endpoint --endpoint-name

Nom du point de terminaison de routage.

--hub-name

Nom d’IoT Hub.

--name --route-name -n

Nom de l’itinéraire.

--source --source-type --type -s

Source de l’itinéraire.

valeurs acceptées: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

Paramètres facultatifs

--condition -c

Condition évaluée pour appliquer la règle de routage.

--enabled -e

Valeur booléenne indiquant s’il faut activer l’itinéraire vers le hub Iot.

valeurs acceptées: false, true
--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 route delete

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « iot hub route » est déconseillé et sera supprimé dans une prochaine version. Utilisez le groupe de commandes d’itinéraire de message d’extension IoT (azure-iot) (az iot hub message-route) à la place.

Supprimez tout ou itinéraire mentionné pour votre IoT Hub.

Supprimez un itinéraire ou tous les itinéraires pour votre IoT Hub.

az iot hub route delete [--hub-name]
                        [--ids]
                        [--name]
                        [--resource-group]
                        [--source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                        [--subscription]

Exemples

Supprimez l’itinéraire « R1 » de « MyIotHub » IoT Hub.

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub --route-name R1

Supprimez tous les itinéraires du type source « DeviceMessages » à partir de « MyIotHub » IoT Hub.

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

Supprimez tous les itinéraires d’IoT Hub « MyIotHub ».

az iot hub route delete -g MyResourceGroup --hub-name MyIotHub

Paramètres facultatifs

--hub-name

Nom d’IoT Hub.

--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 --route-name -n

Nom de l’itinéraire.

--resource-group -g

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

--source --source-type --type -s

Source de l’itinéraire.

valeurs acceptées: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--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 iot hub route list

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « iot hub route » est déconseillé et sera supprimé dans une prochaine version. Utilisez le groupe de commandes d’itinéraire de message d’extension IoT (azure-iot) (az iot hub message-route) à la place.

Obtenez tous les itinéraires dans IoT Hub.

Obtenez des informations sur tous les itinéraires à partir d’un Hub IoT.

az iot hub route list [--hub-name]
                      [--ids]
                      [--resource-group]
                      [--source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                      [--subscription]

Exemples

Obtenez tout l’itinéraire à partir de « MyIotHub » IoT Hub.

az iot hub route list -g MyResourceGroup --hub-name MyIotHub

Obtenez tous les itinéraires du type de source « DeviceMessages » à partir de « MyIotHub » IoT Hub.

az iot hub route list -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

Paramètres facultatifs

--hub-name

Nom d’IoT Hub.

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

--resource-group -g

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

--source --source-type --type -s

Source de l’itinéraire.

valeurs acceptées: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--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 iot hub route show

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « iot hub route » est déconseillé et sera supprimé dans une prochaine version. Utilisez le groupe de commandes d’itinéraire de message d’extension IoT (azure-iot) (az iot hub message-route) à la place.

Obtenez des informations sur l’itinéraire dans IoT Hub.

Obtenez des informations sur un itinéraire spécifique dans votre IoT Hub.

az iot hub route show --name
                      [--hub-name]
                      [--ids]
                      [--resource-group]
                      [--subscription]

Exemples

Obtenez des informations de routage à partir de « MyIotHub » IoT Hub.

az iot hub route show -g MyResourceGroup --hub-name MyIotHub --route-name {routeName}

Paramètres obligatoires

--name --route-name -n

Nom de l’itinéraire.

Paramètres facultatifs

--hub-name

Nom d’IoT Hub.

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

--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 iot hub route test

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « iot hub route » est déconseillé et sera supprimé dans une prochaine version. Utilisez le groupe de commandes d’itinéraire de message d’extension IoT (azure-iot) (az iot hub message-route) à la place.

Testez tous les itinéraires ou itinéraires mentionnés dans IoT Hub.

Testez tous les itinéraires existants ou tous les itinéraires mentionnés dans votre IoT Hub. Vous pouvez fournir un exemple de message pour tester vos itinéraires.

az iot hub route test [--ap]
                      [--body]
                      [--hub-name]
                      [--ids]
                      [--name]
                      [--resource-group]
                      [--source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                      [--sp]
                      [--subscription]

Exemples

Testez l’itinéraire « R1 » à partir de « MyIotHub » IoT Hub.

az iot hub route test -g MyResourceGroup --hub-name MyIotHub --route-name R1

Testez tout l’itinéraire du type source « DeviceMessages » à partir de « MyIotHub » IoT Hub.

az iot hub route test -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages

Paramètres facultatifs

--ap --app-properties

Propriétés de l’application du message de routage.

--body -b

Corps du message de routage.

--hub-name

Nom d’IoT Hub.

--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 --route-name -n

Nom de l’itinéraire.

--resource-group -g

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

--source --source-type --type -s

Source de l’itinéraire.

valeurs acceptées: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--sp --system-properties

Propriétés système du message de routage.

--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 iot hub route update

Modifier
Déprécié

Cette commande est implicitement déconseillée, car le groupe de commandes « iot hub route » est déconseillé et sera supprimé dans une prochaine version. Utilisez le groupe de commandes d’itinéraire de message d’extension IoT (azure-iot) (az iot hub message-route) à la place.

Mettez à jour un itinéraire dans IoT Hub.

Mises à jour un itinéraire dans IoT Hub. Vous pouvez modifier la source, le point de terminaison ou la requête sur l’itinéraire.

az iot hub route update --name
                        [--condition]
                        [--en]
                        [--enabled {false, true}]
                        [--hub-name]
                        [--ids]
                        [--resource-group]
                        [--source {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                        [--subscription]

Exemples

Mettez à jour le type de source de l’itinéraire « R1 » à partir de « MyIotHub » IoT Hub.

az iot hub route update -g MyResourceGroup --hub-name MyIotHub --source DeviceMessages --route-name R1

Paramètres obligatoires

--name --route-name -n

Nom de l’itinéraire.

Paramètres facultatifs

--condition -c

Condition évaluée pour appliquer la règle de routage.

--en --endpoint --endpoint-name

Nom du point de terminaison de routage.

--enabled -e

Valeur booléenne indiquant s’il faut activer l’itinéraire vers le hub Iot.

valeurs acceptées: false, true
--hub-name

Nom d’IoT Hub.

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

--resource-group -g

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

--source --source-type --type -s

Source de l’itinéraire.

valeurs acceptées: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--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.