IotHubBaseClient.UpdateReportedPropertiesAsync 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.

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

Task<Int64>

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

Exceptions

OperationCanceledException

Thrown when the operation has been canceled.

Applies to