Share via

RouteProperties interface

  • Reference
Package:
@azure/arm-iothub-profile-2020-09-01-hybrid

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Properties

condition

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates 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 messages that satisfy the condition are routed. Currently only one endpoint is allowed.
isEnabled

Used to specify whether a 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 that the routing rule is to be applied to, such as DeviceMessages.

Property Details

condition

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates 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 messages that satisfy the condition are routed. Currently only one endpoint is allowed.

endpointNames: string[]

Property Value

string[]

isEnabled

Used to specify whether a 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 that the routing rule is to be applied to, such as DeviceMessages.

source: string

Property Value

string