RouteProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The properties of a routing rule that your IoT hub uses to route messages to endpoints.
public class RouteProperties
type RouteProperties = class
Public Class RouteProperties
- Inheritance
-
RouteProperties
Constructors
RouteProperties() |
Initializes a new instance of the RouteProperties class. |
RouteProperties(String, String, IList<String>, Boolean, String) |
Initializes a new instance of the RouteProperties class. |
Properties
Condition |
Gets or sets 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 |
Gets or sets the list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. |
IsEnabled |
Gets or sets used to specify whether a route is enabled. |
Name |
Gets or sets 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 |
Gets or sets the source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: 'Invalid', 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents', 'DeviceConnectionStateEvents' |
Methods
Validate() |
Validate the object. |