RouteProperties Class

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.iothub._serialization.Model
RouteProperties

Constructor

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

Keyword-Only Parameters

Name Description
name
str

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. Required.

source

The source that the routing rule is to be applied to, such as DeviceMessages. Required. Known values are: "Invalid", "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", and "DeviceConnectionStateEvents".

condition
str

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

endpoint_names

The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. Required.

is_enabled

Used to specify whether a route is enabled. Required.

Variables

Name Description
name
str

The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. Required.

source

The source that the routing rule is to be applied to, such as DeviceMessages. Required. Known values are: "Invalid", "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", and "DeviceConnectionStateEvents".

condition
str

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

endpoint_names

The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. Required.

is_enabled

Used to specify whether a route is enabled. Required.