DigitalTwinsClient.DeleteRelationship Method

Definition

Deletes a relationship on a digital twin synchronously.

public virtual Azure.Response DeleteRelationship (string digitalTwinId, string relationshipId, Azure.ETag? ifMatch = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteRelationship : string * string * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.Response
override this.DeleteRelationship : string * string * Nullable<Azure.ETag> * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteRelationship (digitalTwinId As String, relationshipId As String, 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 delete.

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