Share via


EndpointHealthData Class

Definition

The health data for an endpoint

public class EndpointHealthData
type EndpointHealthData = class
Public Class EndpointHealthData
Inheritance
EndpointHealthData

Constructors

EndpointHealthData()

Initializes a new instance of the EndpointHealthData class.

EndpointHealthData(String, String, String, Nullable<DateTime>, Nullable<DateTime>, Nullable<DateTime>)

Initializes a new instance of the EndpointHealthData class.

Properties

EndpointId

Gets or sets id of the endpoint

HealthStatus

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'

LastKnownError

Gets or sets last error obtained when a message failed to be delivered to iot hub

LastKnownErrorTime

Gets or sets time at which the last known error occurred

LastSendAttemptTime

Gets or sets last time iot hub tried to send a message to the endpoint

LastSuccessfulSendAttemptTime

Gets or sets last time iot hub successfully sent a message to the endpoint

Applies to