Share via

FallbackRouteProperties Class

  • Reference

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
azure.mgmt.iothub._serialization.Model
FallbackRouteProperties

Constructor

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

Keyword-Only Parameters

Name Description
source
str or RoutingSource

The source to which the routing rule is to be applied to. e.g. DeviceMessages. Required. Known values are: "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", and "DeviceJobLifecycleEvents".
condition
str

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]

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

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

Variables

Name Description
source
str or RoutingSource

The source to which the routing rule is to be applied to. e.g. DeviceMessages. Required. Known values are: "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", and "DeviceJobLifecycleEvents".
condition
str

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]

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

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