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

Constructor

FallbackRouteProperties(*, source: str | _models.RoutingSource, endpoint_names: List[str], is_enabled: bool, name: str | None = None, 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.

source

The source to which the routing rule is to be applied to. For example, DeviceMessages. Required. Known values are: "Invalid", "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", and "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

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

is_enabled

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

source

The source to which the routing rule is to be applied to. For example, DeviceMessages. Required. Known values are: "Invalid", "DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents", and "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

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

is_enabled

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