-
Notifications
You must be signed in to change notification settings - Fork 255
/
EndpointHealthData.xml
290 lines (290 loc) · 17.4 KB
/
EndpointHealthData.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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<Type Name="EndpointHealthData" FullName="Microsoft.Azure.Management.IotHub.Models.EndpointHealthData">
<TypeSignature Language="C#" Value="public class EndpointHealthData" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EndpointHealthData extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.IotHub.Models.EndpointHealthData" />
<TypeSignature Language="VB.NET" Value="Public Class EndpointHealthData" />
<TypeSignature Language="F#" Value="type EndpointHealthData = 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 health data for an endpoint
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EndpointHealthData ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.#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 EndpointHealthData class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EndpointHealthData (string endpointId = default, string healthStatus = default, string lastKnownError = default, DateTime? lastKnownErrorTime = default, DateTime? lastSuccessfulSendAttemptTime = default, DateTime? lastSendAttemptTime = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string endpointId, string healthStatus, string lastKnownError, valuetype System.Nullable`1<valuetype System.DateTime> lastKnownErrorTime, valuetype System.Nullable`1<valuetype System.DateTime> lastSuccessfulSendAttemptTime, valuetype System.Nullable`1<valuetype System.DateTime> lastSendAttemptTime) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.#ctor(System.String,System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional endpointId As String = Nothing, Optional healthStatus As String = Nothing, Optional lastKnownError As String = Nothing, Optional lastKnownErrorTime As Nullable(Of DateTime) = Nothing, Optional lastSuccessfulSendAttemptTime As Nullable(Of DateTime) = Nothing, Optional lastSendAttemptTime As Nullable(Of DateTime) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.IotHub.Models.EndpointHealthData : string * string * string * Nullable<DateTime> * Nullable<DateTime> * Nullable<DateTime> -> Microsoft.Azure.Management.IotHub.Models.EndpointHealthData" Usage="new Microsoft.Azure.Management.IotHub.Models.EndpointHealthData (endpointId, healthStatus, lastKnownError, lastKnownErrorTime, lastSuccessfulSendAttemptTime, lastSendAttemptTime)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpointId" Type="System.String" />
<Parameter Name="healthStatus" Type="System.String" />
<Parameter Name="lastKnownError" Type="System.String" />
<Parameter Name="lastKnownErrorTime" Type="System.Nullable<System.DateTime>" />
<Parameter Name="lastSuccessfulSendAttemptTime" Type="System.Nullable<System.DateTime>" />
<Parameter Name="lastSendAttemptTime" Type="System.Nullable<System.DateTime>" />
</Parameters>
<Docs>
<param name="endpointId">Id of the endpoint</param>
<param name="healthStatus">Health statuses have following meanings.
The 'healthy' status shows that the endpoint is accepting messages
as expected. The 'unhealthy' status shows that the endpoint is not
accepting messages as expected and IoT Hub is retrying to send data
to this endpoint. The status of an unhealthy endpoint will be
updated to healthy when IoT Hub has established an eventually
consistent state of health. The 'dead' status shows that the
endpoint is not accepting messages, after IoT Hub retried sending
messages for the retrial period. See IoT Hub metrics to identify
errors and monitor issues with endpoints. The 'unknown' status
shows that the IoT Hub has not established a connection with the
endpoint. No messages have been delivered to or rejected from this
endpoint. Possible values include: 'unknown', 'healthy',
'degraded', 'unhealthy', 'dead'</param>
<param name="lastKnownError">Last error obtained when a message
failed to be delivered to iot hub</param>
<param name="lastKnownErrorTime">Time at which the last known error
occurred</param>
<param name="lastSuccessfulSendAttemptTime">Last time iot hub
successfully sent a message to the endpoint</param>
<param name="lastSendAttemptTime">Last time iot hub tried to send a
message to the endpoint</param>
<summary>
Initializes a new instance of the EndpointHealthData class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EndpointId">
<MemberSignature Language="C#" Value="public string EndpointId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EndpointId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.EndpointId" />
<MemberSignature Language="VB.NET" Value="Public Property EndpointId As String" />
<MemberSignature Language="F#" Value="member this.EndpointId : string with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.EndpointId" />
<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="endpointId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="endpointId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets id of the endpoint
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HealthStatus">
<MemberSignature Language="C#" Value="public string HealthStatus { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string HealthStatus" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.HealthStatus" />
<MemberSignature Language="VB.NET" Value="Public Property HealthStatus As String" />
<MemberSignature Language="F#" Value="member this.HealthStatus : string with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.HealthStatus" />
<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="healthStatus")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="healthStatus")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets health statuses have following meanings. The 'healthy'
status shows that the endpoint is accepting messages as expected.
The 'unhealthy' status shows that the endpoint is not accepting
messages as expected and IoT Hub is retrying to send data to this
endpoint. The status of an unhealthy endpoint will be updated to
healthy when IoT Hub has established an eventually consistent state
of health. The 'dead' status shows that the endpoint is not
accepting messages, after IoT Hub retried sending messages for the
retrial period. See IoT Hub metrics to identify errors and monitor
issues with endpoints. The 'unknown' status shows that the IoT Hub
has not established a connection with the endpoint. No messages
have been delivered to or rejected from this endpoint. Possible
values include: 'unknown', 'healthy', 'degraded', 'unhealthy',
'dead'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastKnownError">
<MemberSignature Language="C#" Value="public string LastKnownError { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string LastKnownError" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.LastKnownError" />
<MemberSignature Language="VB.NET" Value="Public Property LastKnownError As String" />
<MemberSignature Language="F#" Value="member this.LastKnownError : string with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.LastKnownError" />
<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="lastKnownError")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="lastKnownError")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets last error obtained when a message failed to be
delivered to iot hub
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastKnownErrorTime">
<MemberSignature Language="C#" Value="public DateTime? LastKnownErrorTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> LastKnownErrorTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.LastKnownErrorTime" />
<MemberSignature Language="VB.NET" Value="Public Property LastKnownErrorTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.LastKnownErrorTime : Nullable<DateTime> with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.LastKnownErrorTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="lastKnownErrorTime")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="lastKnownErrorTime")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets time at which the last known error occurred
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastSendAttemptTime">
<MemberSignature Language="C#" Value="public DateTime? LastSendAttemptTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> LastSendAttemptTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.LastSendAttemptTime" />
<MemberSignature Language="VB.NET" Value="Public Property LastSendAttemptTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.LastSendAttemptTime : Nullable<DateTime> with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.LastSendAttemptTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="lastSendAttemptTime")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="lastSendAttemptTime")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets last time iot hub tried to send a message to the
endpoint
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastSuccessfulSendAttemptTime">
<MemberSignature Language="C#" Value="public DateTime? LastSuccessfulSendAttemptTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> LastSuccessfulSendAttemptTime" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.LastSuccessfulSendAttemptTime" />
<MemberSignature Language="VB.NET" Value="Public Property LastSuccessfulSendAttemptTime As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.LastSuccessfulSendAttemptTime : Nullable<DateTime> with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.EndpointHealthData.LastSuccessfulSendAttemptTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Rest.Serialization.DateTimeRfc1123JsonConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="lastSuccessfulSendAttemptTime")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="lastSuccessfulSendAttemptTime")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets last time iot hub successfully sent a message to the
endpoint
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>