Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AutoPR iothub/resource-manager] changes to improve documentation of endpoint health statuses for routing #4450

Merged
merged 1 commit into from
Feb 28, 2019
Merged

[AutoPR iothub/resource-manager] changes to improve documentation of endpoint health statuses for routing #4450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions azure-mgmt-iothub/azure/mgmt/iothub/models/endpoint_health_data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,18 @@ class EndpointHealthData(Model):

:param endpoint_id: Id of the endpoint
:type endpoint_id: str
:param health_status: Health status. Possible values include: 'unknown',
'healthy', 'unhealthy', 'dead'
:param health_status: 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', 'unhealthy', 'dead'
:type health_status: str or ~azure.mgmt.iothub.models.EndpointHealthStatus
"""

Expand Down
14 changes: 12 additions & 2 deletions azure-mgmt-iothub/azure/mgmt/iothub/models/endpoint_health_data_py3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,18 @@ class EndpointHealthData(Model):

:param endpoint_id: Id of the endpoint
:type endpoint_id: str
:param health_status: Health status. Possible values include: 'unknown',
'healthy', 'unhealthy', 'dead'
:param health_status: 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', 'unhealthy', 'dead'
:type health_status: str or ~azure.mgmt.iothub.models.EndpointHealthStatus
"""

Expand Down