FallbackRouteProperties Class

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

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

Inheritance

Model

FallbackRouteProperties

Constructor

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

Variables

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.

source

str or RoutingSource

Required. The source to which the routing rule is to be applied to. For example, DeviceMessages. Possible values include: "Invalid", "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", "DeviceConnectionStateEvents".

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]

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. Used to specify whether the fallback route is enabled.