ArmIotHubModelFactory.IotHubEndpointHealthInfo Method

  • 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:
ArmIotHubModelFactory.cs

Initializes a new instance of IotHubEndpointHealthInfo.

public static Azure.ResourceManager.IotHub.Models.IotHubEndpointHealthInfo IotHubEndpointHealthInfo (string endpointId = default, Azure.ResourceManager.IotHub.Models.IotHubEndpointHealthStatus? healthStatus = default, string lastKnownError = default, DateTimeOffset? lastKnownErrorOn = default, DateTimeOffset? lastSuccessfulSendAttemptOn = default, DateTimeOffset? lastSendAttemptOn = default);
static member IotHubEndpointHealthInfo : string * Nullable<Azure.ResourceManager.IotHub.Models.IotHubEndpointHealthStatus> * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> -> Azure.ResourceManager.IotHub.Models.IotHubEndpointHealthInfo
Public Shared Function IotHubEndpointHealthInfo (Optional endpointId As String = Nothing, Optional healthStatus As Nullable(Of IotHubEndpointHealthStatus) = Nothing, Optional lastKnownError As String = Nothing, Optional lastKnownErrorOn As Nullable(Of DateTimeOffset) = Nothing, Optional lastSuccessfulSendAttemptOn As Nullable(Of DateTimeOffset) = Nothing, Optional lastSendAttemptOn As Nullable(Of DateTimeOffset) = Nothing) As IotHubEndpointHealthInfo

Parameters

endpointId
String

Id of the endpoint.

healthStatus
Nullable<IotHubEndpointHealthStatus>

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.

lastKnownErrorOn
Nullable<DateTimeOffset>

Time at which the last known error occurred.

lastSuccessfulSendAttemptOn
Nullable<DateTimeOffset>

Last time iot hub successfully sent a message to the endpoint.

lastSendAttemptOn
Nullable<DateTimeOffset>

Last time iot hub tried to send a message to the endpoint.

Returns

IotHubEndpointHealthInfo

A new IotHubEndpointHealthInfo instance for mocking.

Applies to