RoutingRuleProperties 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 RoutingRuleProperties
public class RoutingRuleProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotHub.Models.RoutingRuleProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotHub.Models.RoutingRuleProperties>
type RoutingRuleProperties = class
type RoutingRuleProperties = class
interface IJsonModel<RoutingRuleProperties>
interface IPersistableModel<RoutingRuleProperties>
Public Class RoutingRuleProperties
Public Class RoutingRuleProperties
Implements IJsonModel(Of RoutingRuleProperties), IPersistableModel(Of RoutingRuleProperties)
- Inheritance
-
RoutingRuleProperties
- Implements
Constructors
RoutingRuleProperties(String, IotHubRoutingSource, IEnumerable<String>, Boolean) |
Initializes a new instance of RoutingRuleProperties. |
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. |
Methods
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
IJsonModel<RoutingRuleProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<RoutingRuleProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<RoutingRuleProperties>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<RoutingRuleProperties>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<RoutingRuleProperties>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |