DigitalTwinsClient.UpdateComponent Method
Definition
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.
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.ResponsePublic 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 ResponseParameters
- 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.
Optional. Only perform the operation if the entity's ETag matches this optional ETag or * (All) is provided.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
The HTTP response Response<T>. This response object includes an HTTP header that gives you the updated ETag for this resource.
Exceptions
<exception cref="T:System.ArgumentNullException">
The exception is thrown when
digitalTwinId or componentName is null.
</exception>
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.
