IotHubBaseClient.UpdateReportedPropertiesAsync Method

Definition

Push reported property changes up to the service.

public System.Threading.Tasks.Task<long> UpdateReportedPropertiesAsync (Microsoft.Azure.Devices.Client.ReportedProperties reportedProperties, System.Threading.CancellationToken cancellationToken = default);
member this.UpdateReportedPropertiesAsync : Microsoft.Azure.Devices.Client.ReportedProperties * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int64>
Public Function UpdateReportedPropertiesAsync (reportedProperties As ReportedProperties, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Long)

Parameters

reportedProperties
ReportedProperties

Reported properties to push

cancellationToken
CancellationToken

A cancellation token to cancel the operation.

Returns

The new version of the updated twin if the update was successful.

Exceptions

Thrown when the operation has been canceled.

Applies to