From 7311fd41d1714f152d4569e6641c8821a0273ae4 Mon Sep 17 00:00:00 2001 From: vash Date: Wed, 27 Feb 2019 16:02:30 -0800 Subject: [PATCH] changes to improve documentation of endpoint health statuses for routing --- .../Microsoft.Devices/preview/2018-12-01-preview/iothub.json | 2 +- .../Microsoft.Devices/stable/2018-04-01/iothub.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json index 2a8609972583..e78b09697e1b 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json @@ -2698,7 +2698,7 @@ "type": "string" }, "healthStatus": { - "description": "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", "enum": [ "unknown", "healthy", diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json index ed9e7bc1b5d5..439527990cf7 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json @@ -2675,7 +2675,7 @@ "type": "string" }, "healthStatus": { - "description": "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", "enum": [ "unknown", "healthy",