Partager via


RouteProperties Classe

Propriétés d’une règle de routage que votre hub IoT utilise pour acheminer les messages vers les points de terminaison.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.

Héritage
azure.mgmt.iothub._serialization.Model
RouteProperties

Constructeur

RouteProperties(*, name: str, source: str | _models.RoutingSource, endpoint_names: List[str], is_enabled: bool, condition: str | None = None, **kwargs: Any)

Paramètres de mot clé uniquement

Nom Description
name
str

Nom de l'itinéraire. Le nom peut inclure uniquement des caractères alphanumériques, des points, des traits de soulignement, des traits d’union, une longueur maximale de 64 caractères et doit être unique. Obligatoire.

source

Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages. Obligatoire. Les valeurs connues sont « Invalid », « DeviceMessages », « TwinChangeEvents », « DeviceLifecycleEvents », « DeviceJobLifecycleEvents », « DigitalTwinChangeEvents », « DeviceConnectionStateEvents » et « MqttBrokerMessages ».

condition
str

Condition évaluée pour appliquer la règle de routage. Si aucune condition n’est fournie, elle prend la valeur true par défaut. Pour plus d’informations sur la grammaire, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

endpoint_names

Liste des points de terminaison vers lesquels les messages qui satisfont à la condition sont routés. Actuellement, un seul point de terminaison est autorisé. Obligatoire.

is_enabled

Permet de spécifier si un itinéraire est activé. Obligatoire.

Variables

Nom Description
name
str

Nom de l'itinéraire. Le nom peut inclure uniquement des caractères alphanumériques, des points, des traits de soulignement, des traits d’union, une longueur maximale de 64 caractères et doit être unique. Obligatoire.

source

Source à laquelle la règle de routage doit être appliquée, telle que DeviceMessages. Obligatoire. Les valeurs connues sont « Invalid », « DeviceMessages », « TwinChangeEvents », « DeviceLifecycleEvents », « DeviceJobLifecycleEvents », « DigitalTwinChangeEvents », « DeviceConnectionStateEvents » et « MqttBrokerMessages ».

condition
str

Condition évaluée pour appliquer la règle de routage. Si aucune condition n’est fournie, elle prend la valeur true par défaut. Pour plus d’informations sur la grammaire, consultez : https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

endpoint_names

Liste des points de terminaison vers lesquels les messages qui satisfont à la condition sont routés. Actuellement, un seul point de terminaison est autorisé. Obligatoire.

is_enabled

Permet de spécifier si un itinéraire est activé. Obligatoire.