TwinsClient.UpdateAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

Package:: Microsoft.Azure.Devices 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.

Overloads

UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken)	Update the mutable fields for a list of module twins previously created within the system.
UpdateAsync(String, ClientTwin, Boolean, CancellationToken)	Updates the mutable fields of a module's twin.
UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken)	Updates the mutable fields of a module's twin.

UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken)

Update the mutable fields for a list of module twins previously created within the system.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult> UpdateAsync (System.Collections.Generic.IEnumerable<Microsoft.Azure.Devices.ClientTwin> twins, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateAsync : seq<Microsoft.Azure.Devices.ClientTwin> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>
override this.UpdateAsync : seq<Microsoft.Azure.Devices.ClientTwin> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>

Public Overridable Function UpdateAsync (twins As IEnumerable(Of ClientTwin), Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkRegistryOperationResult)

Parameters

twins: IEnumerable<ClientTwin>

List of ClientTwins with updated fields.

onlyIfUnchanged: Boolean

If false, this operation will be performed even if the provided device identity has an out of date ETag. If true, the operation will throw a IotHubServiceException with PreconditionFailed if the provided device identity has an out of date ETag. An up-to-date ETag can be retrieved using GetAsync(String, String, CancellationToken).

cancellationToken: CancellationToken

Task cancellation token.

Returns

Task<BulkRegistryOperationResult>

updated module twin.

Exceptions

ArgumentNullException

When the provided twins is null.

ArgumentException

When the provided twins enumeration is empty.

InvalidOperationException

When a twin is missing an expected ETag.

IotHubServiceException

If IoT hub responded to the request with a non-successful status code. For example, if the provided request was throttled, IotHubServiceException with ThrottlingException is thrown. For a complete list of possible error cases, see IotHubServiceErrorCode.

HttpRequestException

If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.

OperationCanceledException

If the provided cancellationToken has requested cancellation.

Applies to

UpdateAsync(String, ClientTwin, Boolean, CancellationToken)

Updates the mutable fields of a module's twin.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin> UpdateAsync (string deviceId, Microsoft.Azure.Devices.ClientTwin twinPatch, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateAsync : string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>
override this.UpdateAsync : string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>

Public Overridable Function UpdateAsync (deviceId As String, twinPatch As ClientTwin, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientTwin)

Parameters

deviceId: String

The device Id.

twinPatch: ClientTwin

Twin with updated fields.

onlyIfUnchanged: Boolean

cancellationToken: CancellationToken

Task cancellation token.

Returns

Task<ClientTwin>

Updated device twin.

Exceptions

ArgumentNullException

When the provided deviceId or twinPatch is null.

ArgumentException

If the deviceId is empty or white space.

IotHubServiceException

HttpRequestException

If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.

OperationCanceledException

If the provided cancellationToken has requested cancellation.

Applies to

UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken)

Updates the mutable fields of a module's twin.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin> UpdateAsync (string deviceId, string moduleId, Microsoft.Azure.Devices.ClientTwin twinPatch, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateAsync : string * string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>
override this.UpdateAsync : string * string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>

Public Overridable Function UpdateAsync (deviceId As String, moduleId As String, twinPatch As ClientTwin, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientTwin)

Parameters

deviceId: String

The device Id.

moduleId: String

The module Id.

twinPatch: ClientTwin

Twin with updated fields.

onlyIfUnchanged: Boolean

If false, this operation will be performed even if the provided device identity has an out of date ETag. If true, the operation will throw a IotHubServiceException with PreconditionFailed if the provided device/module identity has an out of date ETag. An up-to-date ETag can be retrieved using GetAsync(String, String, CancellationToken).