-
Notifications
You must be signed in to change notification settings - Fork 256
/
RouteProperties.xml
262 lines (262 loc) · 14 KB
/
RouteProperties.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<Type Name="RouteProperties" FullName="Microsoft.Azure.Management.IotHub.Models.RouteProperties">
<TypeSignature Language="C#" Value="public class RouteProperties" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RouteProperties extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.IotHub.Models.RouteProperties" />
<TypeSignature Language="VB.NET" Value="Public Class RouteProperties" />
<TypeSignature Language="F#" Value="type RouteProperties = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The properties of a routing rule that your IoT hub uses to route
messages to endpoints.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RouteProperties ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.IotHub.Models.RouteProperties.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the RouteProperties class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RouteProperties (string name, string source, System.Collections.Generic.IList<string> endpointNames, bool isEnabled, string condition = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, string source, class System.Collections.Generic.IList`1<string> endpointNames, bool isEnabled, string condition) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.IotHub.Models.RouteProperties.#ctor(System.String,System.String,System.Collections.Generic.IList{System.String},System.Boolean,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, source As String, endpointNames As IList(Of String), isEnabled As Boolean, Optional condition As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.IotHub.Models.RouteProperties : string * string * System.Collections.Generic.IList<string> * bool * string -> Microsoft.Azure.Management.IotHub.Models.RouteProperties" Usage="new Microsoft.Azure.Management.IotHub.Models.RouteProperties (name, source, endpointNames, isEnabled, condition)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="source" Type="System.String" />
<Parameter Name="endpointNames" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="isEnabled" Type="System.Boolean" />
<Parameter Name="condition" Type="System.String" />
</Parameters>
<Docs>
<param name="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.</param>
<param name="source">The source that the routing rule is to be
applied to, such as DeviceMessages. Possible values include:
'Invalid', 'DeviceMessages', 'TwinChangeEvents',
'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents',
'DeviceConnectionStateEvents'</param>
<param name="endpointNames">The list of endpoints to which messages
that satisfy the condition are routed. Currently only one endpoint
is allowed.</param>
<param name="isEnabled">Used to specify whether a route is
enabled.</param>
<param name="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</param>
<summary>
Initializes a new instance of the RouteProperties class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Condition">
<MemberSignature Language="C#" Value="public string Condition { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Condition" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.RouteProperties.Condition" />
<MemberSignature Language="VB.NET" Value="Public Property Condition As String" />
<MemberSignature Language="F#" Value="member this.Condition : string with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.RouteProperties.Condition" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="condition")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="condition")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
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
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EndpointNames">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> EndpointNames { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> EndpointNames" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.RouteProperties.EndpointNames" />
<MemberSignature Language="VB.NET" Value="Public Property EndpointNames As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.EndpointNames : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.RouteProperties.EndpointNames" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="endpointNames")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="endpointNames")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the list of endpoints to which messages that satisfy
the condition are routed. Currently only one endpoint is allowed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsEnabled">
<MemberSignature Language="C#" Value="public bool IsEnabled { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsEnabled" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.RouteProperties.IsEnabled" />
<MemberSignature Language="VB.NET" Value="Public Property IsEnabled As Boolean" />
<MemberSignature Language="F#" Value="member this.IsEnabled : bool with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.RouteProperties.IsEnabled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="isEnabled")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="isEnabled")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets used to specify whether a route is enabled.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.RouteProperties.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.RouteProperties.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="name")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="name")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
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.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Source">
<MemberSignature Language="C#" Value="public string Source { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Source" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.RouteProperties.Source" />
<MemberSignature Language="VB.NET" Value="Public Property Source As String" />
<MemberSignature Language="F#" Value="member this.Source : string with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.RouteProperties.Source" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="source")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="source")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
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'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.IotHub.Models.RouteProperties.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="routeProperties.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>