Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FallbackRouteProperties

Package version

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

Hierarchy

  • FallbackRouteProperties

Index

Properties

Optional condition

condition: undefined | string

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

endpointNames: string[]

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

isEnabled

isEnabled: boolean

Used to specify whether the fallback route is enabled.

Optional name

name: undefined | string

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.

Generated using TypeDoc