Share via

DigitalTwinsClient.UpdateDigitalTwinAsync Method

  • Reference

Definition

Namespace:
Azure.DigitalTwins.Core
Assembly:
Azure.DigitalTwins.Core.dll
Package:
Azure.DigitalTwins.Core v1.4.0
Source:
DigitalTwinsClient.cs

Updates a digital twin asynchronously.

public virtual System.Threading.Tasks.Task<Azure.Response> UpdateDigitalTwinAsync (string digitalTwinId, Azure.JsonPatchDocument jsonPatchDocument, Azure.ETag? ifMatch = default, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateDigitalTwinAsync : string * Azure.JsonPatchDocument * Nullable<Azure.ETag> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.UpdateDigitalTwinAsync : string * Azure.JsonPatchDocument * Nullable<Azure.ETag> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function UpdateDigitalTwinAsync (digitalTwinId As String, jsonPatchDocument As JsonPatchDocument, Optional ifMatch As Nullable(Of ETag) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

digitalTwinId
String

The Id of the digital twin to update.

jsonPatchDocument
JsonPatchDocument

The application/json-patch+json operations to be performed on the specified digital twin.

ifMatch
Nullable<ETag>

Optional. Only perform the operation if the entity's ETag matches this optional ETag or * (All) is provided.

cancellationToken
CancellationToken

The cancellationToken.

Returns

Task<Response>

The HTTP response Response<T>. This response object includes an HTTP header that gives you the updated ETag for this resource.

Exceptions

RequestFailedException

The exception that captures the errors from the service. Check the ErrorCode and Status properties for more details.

ArgumentNullException

The exception is thrown when digitalTwinId or jsonPatchDocument is null.

Remarks

For more samples, see our repo samples.

Applies to

See also