azure.mgmt.iothub.v2021_03_31.models.EndpointHealthData.yml

### YamlMime:PythonClass
uid: azure.mgmt.iothub.v2021_03_31.models.EndpointHealthData
name: EndpointHealthData
fullName: azure.mgmt.iothub.v2021_03_31.models.EndpointHealthData
module: azure.mgmt.iothub.v2021_03_31.models
inheritances:
- azure.mgmt.iothub._serialization.Model
summary: The health data for an endpoint.
constructor:
  syntax: 'EndpointHealthData(*, endpoint_id: str | None = None, health_status: str
    | _models.EndpointHealthStatus | None = None, last_known_error: str | None = None,
    last_known_error_time: datetime | None = None, last_successful_send_attempt_time:
    datetime | None = None, last_send_attempt_time: datetime | None = None, **kwargs:
    Any)'
  keywordOnlyParameters:
  - name: endpoint_id
    description: Id of the endpoint.
    types:
    - <xref:str>
  - name: 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. Known values are: "unknown",
      "healthy",

      "degraded", "unhealthy", and "dead".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.iothub.v2021_03_31.models.EndpointHealthStatus>
  - name: last_known_error
    description: 'Last error obtained when a message failed to be delivered to iot

      hub.'
    types:
    - <xref:str>
  - name: last_known_error_time
    description: Time at which the last known error occurred.
    types:
    - <xref:datetime.datetime>
  - name: last_successful_send_attempt_time
    description: 'Last time iot hub successfully sent a message to

      the endpoint.'
    types:
    - <xref:datetime.datetime>
  - name: last_send_attempt_time
    description: Last time iot hub tried to send a message to the endpoint.
    types:
    - <xref:datetime.datetime>
variables:
- description: Id of the endpoint.
  name: endpoint_id
  types:
  - <xref:str>
- 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. Known values are: "unknown", "healthy", "degraded",

    "unhealthy", and "dead".'
  name: health_status
  types:
  - <xref:str>
  - <xref:azure.mgmt.iothub.v2021_03_31.models.EndpointHealthStatus>
- description: Last error obtained when a message failed to be delivered to iot hub.
  name: last_known_error
  types:
  - <xref:str>
- description: Time at which the last known error occurred.
  name: last_known_error_time
  types:
  - <xref:datetime.datetime>
- description: 'Last time iot hub successfully sent a message to the

    endpoint.'
  name: last_successful_send_attempt_time
  types:
  - <xref:datetime.datetime>
- description: Last time iot hub tried to send a message to the endpoint.
  name: last_send_attempt_time
  types:
  - <xref:datetime.datetime>