DigitalTwinsClient.DeleteRelationship Method

Reference

Definition

Namespace:: Azure.DigitalTwins.Core

Assembly:: Azure.DigitalTwins.Core.dll

Package:: Azure.DigitalTwins.Core v1.4.0

Source:: DigitalTwinsClient.cs

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.

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: String

The Id of the source digital twin.

relationshipId: String

The Id of the relationship to delete.

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.

Exceptions

RequestFailedException

The exception that captures the errors from the service. Check the ErrorCode and Status properties for more details.

ArgumentNullException

The exception is thrown when digitalTwinId or relationshipId is null.

Remarks

For more samples, see our repo samples.

Applies to

Share via