IotHubEndpointHealthInfo Class

Reference

Definition

Namespace:: Azure.ResourceManager.IotHub.Models

Assembly:: Azure.ResourceManager.IotHub.dll

Package:: Azure.ResourceManager.IotHub v1.1.1

Package:: Azure.ResourceManager.IotHub v1.2.0-beta.1

Source:: IotHubEndpointHealthInfo.cs

Source:: IotHubEndpointHealthInfo.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The health data for an endpoint.

public class IotHubEndpointHealthInfo

public class IotHubEndpointHealthInfo : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotHub.Models.IotHubEndpointHealthInfo>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotHub.Models.IotHubEndpointHealthInfo>

type IotHubEndpointHealthInfo = class

type IotHubEndpointHealthInfo = class
    interface IJsonModel<IotHubEndpointHealthInfo>
    interface IPersistableModel<IotHubEndpointHealthInfo>

Public Class IotHubEndpointHealthInfo

Public Class IotHubEndpointHealthInfo
Implements IJsonModel(Of IotHubEndpointHealthInfo), IPersistableModel(Of IotHubEndpointHealthInfo)

Inheritance: Object
IotHubEndpointHealthInfo

Implements: IJsonModel<IotHubEndpointHealthInfo> IPersistableModel<IotHubEndpointHealthInfo> IPersistableModel<T>

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.
LastKnownErrorOn	Time at which the last known error occurred.
LastSendAttemptOn	Last time iot hub tried to send a message to the endpoint.
LastSuccessfulSendAttemptOn	Last time iot hub successfully sent a message to the endpoint.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<IotHubEndpointHealthInfo>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<IotHubEndpointHealthInfo>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<IotHubEndpointHealthInfo>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<IotHubEndpointHealthInfo>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<IotHubEndpointHealthInfo>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via