ModulesClient.DeleteAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Paquet:

Microsoft.Azure.Devices v2.0.0-preview002

Surcharges

DeleteAsync(Module, Boolean, CancellationToken)	Supprimez l’identité de module du registre de votre hub IoT.
DeleteAsync(String, String, CancellationToken)	Supprimez l’identité de module avec l’ID fourni de l’appareil avec l’ID fourni dans le registre de votre hub IoT.

DeleteAsync(Module, Boolean, CancellationToken)

Supprimez l’identité de module du registre de votre hub IoT.

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

Paramètres

module

Module

Identité de module à supprimer du registre de votre hub IoT. Si l’ETag du module 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, String, CancellationToken)de . Pour forcer l’exécution de l’opération quel que soit L’ETag, définissez l’ETag de l’identité du module sur « * » ou utilisez DeleteAsync(String, 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 le module fourni a un ETag obsolète. Un ETag à jour peut être récupéré à l’aide GetAsync(String, String, CancellationToken)de .

cancellationToken

CancellationToken

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

Retours

Task

Exceptions

ArgumentNullException

Levée lorsque le module fourni est null.

IotHubServiceException

Levée 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.

DeleteAsync(String, String, CancellationToken)

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

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

Paramètres

deviceId

String

ID de l’identité de l’appareil qui contient le module à supprimer.

moduleId

String

ID de l’identité de module à supprimer.

cancellationToken

CancellationToken

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

Retours

Task

Exceptions

ArgumentNullException

Levée lorsque l’ID d’appareil ou l’ID de module fourni est null.

ArgumentException

Levée lorsque l’ID d’appareil ou l’ID de module fourni est vide ou espace blanc.

IotHubServiceException

Levée 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.