DevicesClient.DeleteAsync Methode

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Paket:

Microsoft.Azure.Devices v2.0.0-preview002

Überlädt

DeleteAsync(String, CancellationToken)	Löschen Sie die Geräteidentität mit der angegebenen ID aus der Registrierung Ihres IoT Hubs.
DeleteAsync(Device, Boolean, CancellationToken)	Löschen Sie die Geräteidentität mit der angegebenen ID aus der Registrierung Ihres IoT Hubs.
DeleteAsync(IEnumerable<Device>, Boolean, CancellationToken)	Löschen Sie bis zu 100 Geräteidentitäten in einem Massenvorgang aus der Registrierung Ihres IoT Hubs.

DeleteAsync(String, CancellationToken)

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

public virtual System.Threading.Tasks.Task DeleteAsync (string deviceId, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function DeleteAsync (deviceId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameter

deviceId

String

Die ID der zu löschenden Geräteidentität.

cancellationToken

CancellationToken

Das Token, mit dem der Vorgang abgebrochen werden kann.

Gibt zurück

Task

Ausnahmen

ArgumentNullException

Wenn die angegebene Geräte-ID NULL ist.

ArgumentException

Wenn die angegebene Geräte-ID leer oder leer ist.

IotHubServiceException

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.

HttpRequestException

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

OperationCanceledException

Wenn das bereitgestellte Abbruchtoken den Abbruch angefordert hat.

DeleteAsync(Device, Boolean, CancellationToken)

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

public virtual System.Threading.Tasks.Task DeleteAsync (Microsoft.Azure.Devices.Device device, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAsync : Microsoft.Azure.Devices.Device * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteAsync : Microsoft.Azure.Devices.Device * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function DeleteAsync (device As Device, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameter

device

Device

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

onlyIfUnchanged

Boolean

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

cancellationToken

CancellationToken

Das Token, mit dem der Vorgang abgebrochen werden kann.

Gibt zurück

Task

Ausnahmen

ArgumentNullException

Wenn das bereitgestellte Gerät NULL ist.

IotHubServiceException

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.

HttpRequestException

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

OperationCanceledException

Wenn das bereitgestellte Abbruchtoken den Abbruch angefordert hat.

DeleteAsync(IEnumerable<Device>, Boolean, CancellationToken)

Löschen Sie bis zu 100 Geräteidentitäten in einem Massenvorgang aus der Registrierung Ihres IoT Hubs.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult> DeleteAsync (System.Collections.Generic.IEnumerable<Microsoft.Azure.Devices.Device> devices, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteAsync : seq<Microsoft.Azure.Devices.Device> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>
override this.DeleteAsync : seq<Microsoft.Azure.Devices.Device> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>

Public Overridable Function DeleteAsync (devices As IEnumerable(Of Device), Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkRegistryOperationResult)

Parameter

devices

IEnumerable<Device>

Die Geräteidentitäten, die aus der Registrierung Ihres IoT Hubs gelöscht werden sollen. Darf 100 Geräte nicht überschreiten.

onlyIfUnchanged

Boolean

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

cancellationToken

CancellationToken

Das Token, mit dem der Vorgang abgebrochen werden kann.

Gibt zurück

Task<BulkRegistryOperationResult>

Das Ergebnis des Massenvorgangs.

Ausnahmen

ArgumentNullException

Wenn die bereitgestellte Gerätesammlung NULL ist.

ArgumentException

Wenn die bereitgestellte Gerätesammlung leer ist.

IotHubServiceException

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.

HttpRequestException

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

OperationCanceledException

Wenn das bereitgestellte Abbruchtoken den Abbruch angefordert hat.