DigitalTwinsClient.UpdateComponent Method

Definition

Namespace:

Azure.DigitalTwins.Core

Assembly:

Azure.DigitalTwins.Core.dll

Package:

Azure.DigitalTwins.Core v1.4.0

Source:

DigitalTwinsClient.cs

Updates properties of a component on a digital twin synchronously.

public virtual Azure.Response UpdateComponent (string digitalTwinId, string componentName, Azure.JsonPatchDocument jsonPatchDocument, Azure.ETag? ifMatch = default, System.Threading.CancellationToken cancellationToken = default);

abstract member UpdateComponent : string * string * Azure.JsonPatchDocument * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.Response
override this.UpdateComponent : string * string * Azure.JsonPatchDocument * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.Response

Public Overridable Function UpdateComponent (digitalTwinId As String, componentName As String, jsonPatchDocument As JsonPatchDocument, Optional ifMatch As Nullable(Of ETag) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

digitalTwinId

String

The Id of the digital twin.

componentName

String

The component being modified.

jsonPatchDocument

JsonPatchDocument

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

ifMatch

Nullable<ETag>

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

cancellationToken

CancellationToken

The cancellation token.

Returns

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.

Remarks

For more samples, see our repo samples.

See also

• UpdateComponentAsync(String, String, JsonPatchDocument, Nullable<ETag>, CancellationToken)