FallbackRouteProperties interface

Package:

@azure/arm-iothub

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

Properties

condition	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
endpointNames	The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.
isEnabled	Used to specify whether the fallback route is enabled.
name	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

Property Details

condition

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

condition?: string

Property Value

string

endpointNames

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

endpointNames: string[]

Property Value

string[]

isEnabled

Used to specify whether the fallback route is enabled.

isEnabled: boolean

Property Value

boolean

name

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.

name?: string

Property Value

string

source

The source to which the routing rule is to be applied to. For example, DeviceMessages

source: string

Property Value

string