EndpointHealthData interface

  • Reference
Package:
@azure/arm-iothub

The health data for an endpoint

Properties

endpointId

Id of the endpoint
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
lastKnownError

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

Time at which the last known error occurred
lastSendAttemptTime

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

Last time iot hub successfully sent a message to the endpoint

Property Details

endpointId

Id of the endpoint

endpointId?: string

Property Value

string

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

healthStatus?: string

Property Value

string

lastKnownError

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

lastKnownError?: string

Property Value

string

lastKnownErrorTime

Time at which the last known error occurred

lastKnownErrorTime?: Date

Property Value

Date

lastSendAttemptTime

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

lastSendAttemptTime?: Date

Property Value

Date

lastSuccessfulSendAttemptTime

Last time iot hub successfully sent a message to the endpoint

lastSuccessfulSendAttemptTime?: Date

Property Value

Date