DigitalTwinsClient.DeleteRelationshipAsync 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.
Deletes a relationship on a digital twin asynchronously.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteRelationshipAsync(string digitalTwinId, string relationshipId, Azure.ETag? ifMatch = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteRelationshipAsync : string * string * Nullable<Azure.ETag> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteRelationshipAsync : string * string * Nullable<Azure.ETag> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteRelationshipAsync (digitalTwinId As String, relationshipId As String, Optional ifMatch As Nullable(Of ETag) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- digitalTwinId
- String
The Id of the source digital twin.
- relationshipId
- String
The Id of the relationship to delete.
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.
Exceptions
<exception cref="T:System.ArgumentNullException">
The exception is thrown when
digitalTwinId or relationshipId 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.
