DigitalTwinsClient.UpdateDigitalTwinAsync Method

Definition

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
System.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
System.Nullable<ETag>

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

cancellationToken
System.Threading.CancellationToken

The cancellationToken.

Returns

System.Threading.Tasks.Task<Response>

The http response Response<T>.

Exceptions

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

System.ArgumentNullException

The exception is thrown when digitalTwinId or jsonPatchDocument is null.

Remarks

For more samples, see our repo samples.

Applies to