DigitalTwinsClient.DeleteDigitalTwin Method

Definition

Deletes a digital twin synchronously.

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

Parameters

digitalTwinId
System.String

The Id of the digital twin 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 is null.

Remarks

To delete a digital twin, any relationships referencing it must be deleted first.

For more samples, see our repo samples.

Applies to