DigitalTwinsClient.UpdateRelationship Method

Definition

Updates the properties of a relationship on a digital twin synchronously.

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

Parameters

digitalTwinId
System.String

The Id of the source digital twin.

relationshipId
System.String

The Id of the relationship to be updated.

jsonPatchDocument
JsonPatchDocument

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

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 cancellation token.

Returns

Response

The http response Response.

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 relationshipId is null.

Remarks

For more samples, see our repo samples.

Applies to

See also