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

Model

RouteProperties

Constructor

RouteProperties(*, name: str, source: Union[str, azure.mgmt.iothub.v2021_07_01.models._iot_hub_client_enums.RoutingSource], endpoint_names: List[str], is_enabled: bool, condition: Optional[str] = None, **kwargs)

Variables

name

str

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

source

str or RoutingSource

Required. The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: "Invalid", "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", "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

list[str]

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

is_enabled

bool

Required. Used to specify whether a route is enabled.