DigitalTwinClient.UpdateDigitalTwinAsync Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v1.38.1

Updates a digital twin.

public virtual System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.Devices.DigitalTwinUpdateHeaders>> UpdateDigitalTwinAsync (string digitalTwinId, string digitalTwinUpdateOperations, Microsoft.Azure.Devices.DigitalTwinUpdateRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateDigitalTwinAsync : string * string * Microsoft.Azure.Devices.DigitalTwinUpdateRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.Devices.DigitalTwinUpdateHeaders>>
override this.UpdateDigitalTwinAsync : string * string * Microsoft.Azure.Devices.DigitalTwinUpdateRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationHeaderResponse<Microsoft.Azure.Devices.DigitalTwinUpdateHeaders>>

Public Overridable Function UpdateDigitalTwinAsync (digitalTwinId As String, digitalTwinUpdateOperations As String, Optional requestOptions As DigitalTwinUpdateRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationHeaderResponse(Of DigitalTwinUpdateHeaders))

Parameters

digitalTwinId

String

The Id of the digital twin.

digitalTwinUpdateOperations

String

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

requestOptions

DigitalTwinUpdateRequestOptions

The optional settings for this request.

cancellationToken

CancellationToken

The cancellationToken.

Returns

Task<HttpOperationHeaderResponse<DigitalTwinUpdateHeaders>>

The http response.

Remarks

For further information on how to create the json-patch, see https://docs.microsoft.com/azure/iot-pnp/howto-manage-digital-twin.