EndpointHealthData Class

The health data for an endpoint.

Inheritance

Model

EndpointHealthData

Constructor

EndpointHealthData(*, endpoint_id: Optional[str] = None, health_status: Optional[Union[str, azure.mgmt.iothub.v2021_03_31.models._iot_hub_client_enums.EndpointHealthStatus]] = None, last_known_error: Optional[str] = None, last_known_error_time: Optional[datetime.datetime] = None, last_successful_send_attempt_time: Optional[datetime.datetime] = None, last_send_attempt_time: Optional[datetime.datetime] = None, **kwargs)

Variables

endpoint_id

str

Id of the endpoint.

health_status

str or EndpointHealthStatus

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".

last_known_error

str

Last error obtained when a message failed to be delivered to iot hub.

last_known_error_time

datetime

Time at which the last known error occurred.

last_successful_send_attempt_time

datetime

Last time iot hub successfully sent a message to the endpoint.

last_send_attempt_time

datetime

Last time iot hub tried to send a message to the endpoint.