resource_endpoint_health

Creates, updates, deletes, gets or lists a resource_endpoint_health resource.

Overview

Name	resource_endpoint_health
Type	Resource
Id	azure.iot_hub.resource_endpoint_health

Fields

Name	Datatype	Description
endpointId	string	Id of the endpoint
healthStatus	string	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	string	Last error obtained when a message failed to be delivered to iot hub
lastKnownErrorTime	string	Time at which the last known error occurred
lastSendAttemptTime	string	Last time iot hub tried to send a message to the endpoint
lastSuccessfulSendAttemptTime	string	Last time iot hub successfully sent a message to the endpoint

Methods

Name	Accessible by	Required Params	Description
get	SELECT	iotHubName, resourceGroupName, subscriptionId	Get the health for routing endpoints.

SELECT examples

Get the health for routing endpoints.

SELECT
endpointId,
healthStatus,
lastKnownError,
lastKnownErrorTime,
lastSendAttemptTime,
lastSuccessfulSendAttemptTime
FROM azure.iot_hub.resource_endpoint_health
WHERE iotHubName = '{{ iotHubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';