Partager via

az iot hub message-route

  • 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 hub message route 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

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

Commandes

Nom Description Type État
az iot hub message-route create

Ajoutez un itinéraire pour un IoT Hub.

 Extension Preview
az iot hub message-route delete

Supprimez tous les itinéraires ou un itinéraire mentionné dans un Hub IoT.

 Extension Preview
az iot hub message-route fallback

Gérez l’itinéraire de secours d’un hub IoT.

 Extension Preview
az iot hub message-route fallback set

Activez ou désactivez l’itinéraire de secours dans un Hub IoT.

 Extension Preview
az iot hub message-route fallback show

Affichez l’itinéraire de secours d’un IoT Hub.

 Extension Preview
az iot hub message-route list

Obtenez tous les itinéraires dans un Hub IoT.

 Extension Preview
az iot hub message-route show

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

 Extension Preview
az iot hub message-route test

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

 Extension Preview
az iot hub message-route update

Mettez à jour un itinéraire pour un hub IoT.

 Extension Preview

az iot hub message-route create

Préversion

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

Ajoutez un itinéraire pour un IoT Hub.

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

Exemples

Créez un itinéraire pour un Hub IoT avec le point de terminaison et le type de source donnés « DeviceMessages ».

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Créez un itinéraire pour un Hub IoT avec le point de terminaison intégré et le type de source « DeviceMessages ».

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name events --source DeviceMessages

Créez un itinéraire désactivé pour un Hub IoT avec le point de terminaison donné, le type de source « DigitalTwinChangeEvents » et la condition personnalisée.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DigitalTwinChangeEvents --condition {condition} --enabled false

Paramètres obligatoires

--en --endpoint --endpoint-name

Nom du point de terminaison de routage. Pour le point de terminaison intégré, utilisez le nom de point de terminaison « événements ».

--hub-name -n

Nom d’IoT Hub.

--rn --route --route-name

Nom de la route.

--source-type --type -t

Source de l’itinéraire.

Propriété Valeur
Valeurs acceptées: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

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.

--condition -c

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

Propriété Valeur
Valeur par défaut: true
--enabled -e

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

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

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

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 hub message-route delete

Préversion

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

Supprimez tous les itinéraires ou un itinéraire mentionné dans un Hub IoT.

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

Exemples

Supprimez un itinéraire d’un hub IoT.

az iot hub message-route delete -n {iothub_name} --route-name {route_name}

Supprimez tous les itinéraires de type source « DeviceMessages » d’un Hub IoT.

az iot hub message-route delete -n {iothub_name} --source DeviceMessages

Supprimez tous les itinéraires d’un Hub IoT.

az iot hub message-route delete -n {iothub_name}

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.

--hub-name -n

Nom d’IoT Hub.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--rn --route --route-name

Nom de la route.

--source-type --type -t

Source de l’itinéraire.

Propriété Valeur
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 à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--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
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/.

--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 hub message-route list

Préversion

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

Obtenez tous les itinéraires dans un Hub IoT.

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

Exemples

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

az iot hub message-route list -n {iothub_name}

Obtenez tous les itinéraires de type source « DeviceMessages » à partir d’un Hub IoT.

az iot hub message-route list -n {iothub_name} --source DeviceMessages

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.

--hub-name -n

Nom d’IoT Hub.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--source-type --type -t

Source de l’itinéraire.

Propriété Valeur
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 à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
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/.

--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 hub message-route show

Préversion

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

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

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

Exemples

Obtenez des informations de routage à partir d’un Hub IoT.

az iot hub message-route show -n {iothub_name} --route-name {route_name}

Paramètres obligatoires

--rn --route --route-name

Nom de la route.

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.

--hub-name -n

Nom d’IoT Hub.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--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.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
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/.

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

Préversion

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

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

Vous pouvez fournir un exemple de message pour tester vos itinéraires.

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

Exemples

Testez une route à partir d’un hub IoT.

az iot hub message-route test -n {iothub_name} --route-name {route_name}

Testez tous les itinéraires de type source « DeviceMessages » à partir d’un Hub IoT.

az iot hub message-route test -n {iothub_name} --source DeviceMessages

Testez tous les itinéraires à partir d’un Hub IoT avec un message personnalisé, notamment le corps, les propriétés de l’application et les propriétés système.

az iot hub message-route test -n {iothub_name} -b {body} --ap {app_properties} --sp {system_properties}

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.

--ap --app-properties

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

--body -b

Corps du message de routage.

--hub-name -n

Nom d’IoT Hub.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--rn --route --route-name

Nom de la route.

--source-type --type -t

Source de l’itinéraire.

Propriété Valeur
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 à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
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/.

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

Préversion

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

Mettez à jour un itinéraire pour un hub IoT.

Vous pouvez modifier l’état source, point de terminaison, condition ou activé sur l’itinéraire.

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

Exemples

Mettez à jour un itinéraire vers un point de terminaison donné et un type de source « DeviceMessages ».

az iot hub message-route update -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Désactivez un itinéraire.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --enabled false

Modifiez la condition d’un itinéraire.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --condition {condition}

Paramètres obligatoires

--rn --route --route-name

Nom de la route.

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.

--condition -c

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

--en --endpoint --endpoint-name

Nom du point de terminaison de routage. Pour le point de terminaison intégré, utilisez le nom de point de terminaison « événements ».

--enabled -e

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

Propriété Valeur
Valeurs acceptées: false, true
--hub-name -n

Nom d’IoT Hub.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--source-type --type -t

Source de l’itinéraire.

Propriété Valeur
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 à l’aide de az account set -s NAME_OR_ID.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
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/.

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