-
Notifications
You must be signed in to change notification settings - Fork 233
/
azure.mgmt.iothub.v2019_03_22.models.EndpointHealthData.yml
85 lines (67 loc) · 2.76 KB
/
azure.mgmt.iothub.v2019_03_22.models.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
### YamlMime:PythonClass
uid: azure.mgmt.iothub.v2019_03_22.models.EndpointHealthData
name: EndpointHealthData
fullName: azure.mgmt.iothub.v2019_03_22.models.EndpointHealthData
module: azure.mgmt.iothub.v2019_03_22.models
inheritances:
- azure.mgmt.iothub._serialization.Model
summary: The health data for an endpoint.
constructor:
syntax: 'EndpointHealthData(*, endpoint_id: str | None = None, health_status: str
| _models.EndpointHealthStatus | None = None, **kwargs: Any)'
keywordOnlyParameters:
- name: endpoint_id
description: Id of the endpoint.
types:
- <xref:str>
- name: health_status
description: '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. Known values are: "unknown",
"healthy",
"unhealthy", and "dead".'
types:
- <xref:str>
- <xref:azure.mgmt.iothub.v2019_03_22.models.EndpointHealthStatus>
variables:
- description: Id of the endpoint.
name: endpoint_id
types:
- <xref:str>
- description: '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. Known values are: "unknown", "healthy", "unhealthy",
and
"dead".'
name: health_status
types:
- <xref:str>
- <xref:azure.mgmt.iothub.v2019_03_22.models.EndpointHealthStatus>