DevicesClient.DeleteAsync Méthode

Référence

Définition

Espace de noms:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

Paquet:: Microsoft.Azure.Devices v2.0.0-preview002

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Surcharges

DeleteAsync(String, CancellationToken)	Supprimez l’identité de l’appareil avec l’ID fourni dans le registre de votre hub IoT.
DeleteAsync(Device, Boolean, CancellationToken)	Supprimez l’identité de l’appareil avec l’ID fourni dans le registre de votre hub IoT.
DeleteAsync(IEnumerable<Device>, Boolean, CancellationToken)	Supprimez jusqu’à 100 identités d’appareil du registre de votre hub IoT en bloc.

DeleteAsync(String, CancellationToken)

Supprimez l’identité de l’appareil avec l’ID fourni dans le registre de votre hub IoT.

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

Paramètres

deviceId: String

ID de l’identité de l’appareil à supprimer.

cancellationToken: CancellationToken

Jeton qui permet l’annulation de l’opération.

Retours

Task

Exceptions

ArgumentNullException

Lorsque l’ID d’appareil fourni est null.

ArgumentException

Lorsque l’ID d’appareil fourni est vide ou blanc.

IotHubServiceException

Si IoT Hub a répondu à la demande avec un code de status non réussi. Par exemple, si la requête fournie a été limitée, IotHubServiceException avec ThrottlingException est levée. Pour obtenir la liste complète des cas d’erreur possibles, consultez IotHubServiceErrorCode.

HttpRequestException

Si la requête HTTP échoue en raison d’un problème sous-jacent tel que la connectivité réseau, l’échec DNS ou la validation du certificat de serveur.

OperationCanceledException

Si le jeton d’annulation fourni a demandé l’annulation.

S’applique à

DeleteAsync(Device, Boolean, CancellationToken)

Supprimez l’identité de l’appareil avec l’ID fourni dans le registre de votre hub IoT.

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

Paramètres

device: Device

Identité de l’appareil à supprimer du registre de votre hub IoT. Si l’ETag de l’appareil fourni est obsolète, cette opération lève un IotHubServiceException avec PreconditionFailed Un ETag à jour peut être récupéré à l’aide GetAsync(String, CancellationToken)de . Pour forcer l’exécution de l’opération indépendamment de L’ETag, définissez l’ETag de l’identité de l’appareil sur « * » ou utilisez DeleteAsync(String, CancellationToken).

onlyIfUnchanged: Boolean

Si la valeur est false, cette opération de suppression est effectuée même si l’identité de l’appareil fournie a un ETag obsolète. Si la valeur est true, l’opération lève un IotHubServiceException avec PreconditionFailed si l’identité d’appareil fournie a un ETag obsolète. Un ETag à jour peut être récupéré à l’aide de GetAsync(String, CancellationToken).

cancellationToken: CancellationToken

Jeton qui permet l’annulation de l’opération.

Retours

Task

Exceptions

ArgumentNullException

Lorsque l’appareil fourni est null.

IotHubServiceException

HttpRequestException

Si la requête HTTP échoue en raison d’un problème sous-jacent tel que la connectivité réseau, l’échec DNS ou la validation du certificat de serveur.

OperationCanceledException

Si le jeton d’annulation fourni a demandé l’annulation.

S’applique à

DeleteAsync(IEnumerable<Device>, Boolean, CancellationToken)

Supprimez jusqu’à 100 identités d’appareil du registre de votre hub IoT en bloc.

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)