ModulesClient.SetAsync(Module, Boolean, CancellationToken) 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.

Remplacez l’état d’une identité de module par l’état de l’identité de module fournie.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module> SetAsync (Microsoft.Azure.Devices.Module module, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member SetAsync : Microsoft.Azure.Devices.Module * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module>
override this.SetAsync : Microsoft.Azure.Devices.Module * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module>

Public Overridable Function SetAsync (module As Module, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Module)

Paramètres

module: Module

Nouvel état de l’identité de module.

onlyIfUnchanged: Boolean

Si la valeur est false, cette opération 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 de GetAsync(String, String, CancellationToken).

cancellationToken: CancellationToken

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

Retours

Task<Module>

Identité de module récemment mise à jour, y compris son nouvel ETag.

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.

S’applique à

Partager via