-
Notifications
You must be signed in to change notification settings - Fork 180
/
EndpointHealthData.yml
93 lines (93 loc) · 3.21 KB
/
EndpointHealthData.yml
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
### YamlMime:TSType
name: EndpointHealthData
uid: '@azure/arm-iothub.EndpointHealthData'
package: '@azure/arm-iothub'
summary: The health data for an endpoint
fullName: EndpointHealthData
remarks: ''
isDeprecated: false
type: interface
properties:
- name: endpointId
uid: '@azure/arm-iothub.EndpointHealthData.endpointId'
package: '@azure/arm-iothub'
summary: Id of the endpoint
fullName: endpointId
remarks: ''
isDeprecated: false
syntax:
content: 'endpointId?: string'
return:
description: ''
type: string
- name: healthStatus
uid: '@azure/arm-iothub.EndpointHealthData.healthStatus'
package: '@azure/arm-iothub'
summary: >-
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
fullName: healthStatus
remarks: ''
isDeprecated: false
syntax:
content: 'healthStatus?: string'
return:
description: ''
type: string
- name: lastKnownError
uid: '@azure/arm-iothub.EndpointHealthData.lastKnownError'
package: '@azure/arm-iothub'
summary: Last error obtained when a message failed to be delivered to iot hub
fullName: lastKnownError
remarks: ''
isDeprecated: false
syntax:
content: 'lastKnownError?: string'
return:
description: ''
type: string
- name: lastKnownErrorTime
uid: '@azure/arm-iothub.EndpointHealthData.lastKnownErrorTime'
package: '@azure/arm-iothub'
summary: Time at which the last known error occurred
fullName: lastKnownErrorTime
remarks: ''
isDeprecated: false
syntax:
content: 'lastKnownErrorTime?: Date'
return:
description: ''
type: Date
- name: lastSendAttemptTime
uid: '@azure/arm-iothub.EndpointHealthData.lastSendAttemptTime'
package: '@azure/arm-iothub'
summary: Last time iot hub tried to send a message to the endpoint
fullName: lastSendAttemptTime
remarks: ''
isDeprecated: false
syntax:
content: 'lastSendAttemptTime?: Date'
return:
description: ''
type: Date
- name: lastSuccessfulSendAttemptTime
uid: '@azure/arm-iothub.EndpointHealthData.lastSuccessfulSendAttemptTime'
package: '@azure/arm-iothub'
summary: Last time iot hub successfully sent a message to the endpoint
fullName: lastSuccessfulSendAttemptTime
remarks: ''
isDeprecated: false
syntax:
content: 'lastSuccessfulSendAttemptTime?: Date'
return:
description: ''
type: Date