FallbackRouteProperties Class

The properties related to the fallback route based on which the IoT hub routes messages to the fallback endpoint.

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

Inheritance
FallbackRouteProperties

Constructor

FallbackRouteProperties(*, source: typing.Union[str, _ForwardRef('RoutingSource')], endpoint_names: typing.List[str], is_enabled: bool, condition: typing.Union[str, NoneType] = None, **kwargs)

Parameters

source
str or RoutingSource
Required

Required. The source to which the routing rule is to be applied to. e.g. DeviceMessages. Possible values include: "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents".

condition
str
Required

The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

endpoint_names
list[str]
Required

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

is_enabled
bool
Required

Required. Used to specify whether the fallback route is enabled or not.