Freigeben über


ModulesClient.DeleteAsync Methode

Definition

Überlädt

DeleteAsync(Module, Boolean, CancellationToken)

Löschen Sie die Modulidentität aus der Registrierung Ihres IoT Hubs.

DeleteAsync(String, String, CancellationToken)

Löschen Sie die Modulidentität mit der angegebenen ID vom Gerät mit der angegebenen ID aus der Registrierung Ihres IoT Hubs.

DeleteAsync(Module, Boolean, CancellationToken)

Löschen Sie die Modulidentität aus der Registrierung Ihres IoT Hubs.

public virtual System.Threading.Tasks.Task DeleteAsync (Microsoft.Azure.Devices.Module module, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAsync : Microsoft.Azure.Devices.Module * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteAsync : Microsoft.Azure.Devices.Module * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function DeleteAsync (module As Module, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameter

module
Module

Die Modulidentität, die aus der Registrierung Ihres IoT Hubs gelöscht werden soll. Wenn das ETag des bereitgestellten Moduls veraltet ist, löst dieser Vorgang ein mit PreconditionFailed Ein IotHubServiceException aktuelles ETag kann mit GetAsync(String, String, CancellationToken)abgerufen werden aus. Um die Ausführung des Vorgangs unabhängig von ETag zu erzwingen, legen Sie das ETag der Modulidentität auf "*" fest, oder verwenden Sie DeleteAsync(String, String, CancellationToken).

onlyIfUnchanged
Boolean

Wenn false, wird dieser Löschvorgang auch dann ausgeführt, wenn die angegebene Geräteidentität über ein veraltetes ETag verfügt. Wenn true, löst der Vorgang ein mit PreconditionFailed ausIotHubServiceException, wenn das bereitgestellte Modul über ein veraltetes ETag verfügt. Ein aktuelles ETag kann mit GetAsync(String, String, CancellationToken)abgerufen werden.

cancellationToken
CancellationToken

Das Token, mit dem der Vorgang abgebrochen werden kann.

Gibt zurück

Ausnahmen

Wird ausgelöst, wenn das bereitgestellte Modul NULL ist.

Wird ausgelöst, wenn IoT Hub auf die Anforderung mit einem nicht erfolgreichen status-Code reagiert hat. Wenn beispielsweise die bereitgestellte Anforderung gedrosselt wurde, IotHubServiceException wird mit ThrottlingException ausgelöst. Eine vollständige Liste möglicher Fehlerfälle finden Sie unter IotHubServiceErrorCode.

Wenn die HTTP-Anforderung aufgrund eines zugrunde liegenden Problems wie Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung fehlschlägt.

Wenn das bereitgestellte Abbruchtoken den Abbruch angefordert hat.

Gilt für:

DeleteAsync(String, String, CancellationToken)

Löschen Sie die Modulidentität mit der angegebenen ID vom Gerät mit der angegebenen ID aus der Registrierung Ihres IoT Hubs.

public virtual System.Threading.Tasks.Task DeleteAsync (string deviceId, string moduleId, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function DeleteAsync (deviceId As String, moduleId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameter

deviceId
String

Die ID der Geräteidentität, die das zu löschende Modul enthält.

moduleId
String

Die ID der zu löschenden Modulidentität.

cancellationToken
CancellationToken

Das Token, mit dem der Vorgang abgebrochen werden kann.

Gibt zurück

Ausnahmen

Wird ausgelöst, wenn die angegebene Geräte-ID oder Modul-ID NULL ist.

Wird ausgelöst, wenn die angegebene Geräte-ID oder Modul-ID leer oder Leerzeichen ist.

Wird ausgelöst, wenn IoT Hub auf die Anforderung mit einem nicht erfolgreichen status-Code reagiert hat. Wenn beispielsweise die bereitgestellte Anforderung gedrosselt wurde, IotHubServiceException wird mit ThrottlingException ausgelöst. Eine vollständige Liste möglicher Fehlerfälle finden Sie unter IotHubServiceErrorCode.

Wenn die HTTP-Anforderung aufgrund eines zugrunde liegenden Problems wie Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung fehlschlägt.

Wenn das bereitgestellte Abbruchtoken den Abbruch angefordert hat.

Gilt für: