IotHubModuleClient.SendTelemetryAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Devices.Client

Assembly:: Microsoft.Azure.Devices.Client.dll

Package:: Microsoft.Azure.Devices.Client v2.0.0-preview002

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.

Sends an event to IoT hub. IotHubModuleClient instance must be opened already.

public System.Threading.Tasks.Task SendTelemetryAsync (string outputName, Microsoft.Azure.Devices.Client.TelemetryMessage message, System.Threading.CancellationToken cancellationToken = default);

override this.SendTelemetryAsync : string * Microsoft.Azure.Devices.Client.TelemetryMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function SendTelemetryAsync (outputName As String, message As TelemetryMessage, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

outputName: String

The output target for sending the given message.

message: TelemetryMessage

The message to send.

cancellationToken: CancellationToken

A cancellation token to cancel the operation.

Returns

Task

Exceptions

ArgumentNullException

Thrown when a required parameter is null.

OperationCanceledException

Thrown when the operation has been canceled.

InvalidOperationException

Thrown if ModuleClient instance is not opened already.

SocketException

Thrown if a socket error occurs.

WebSocketException

Thrown if an error occurs when performing an operation on a WebSocket connection.

IOException

Thrown if an I/O error occurs.

IotHubClientException

Thrown if an error occurs when communicating with IoT hub service.

Remarks

For more information on IoT Edge module routing https://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes.

In case of a transient issue, retrying the operation should work. In case of a non-transient issue, inspect the error details and take steps accordingly. Please note that the above list is not exhaustive.

Applies to

Share via