TwinsClient.UpdateAsync Méthode
Définition
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
| UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken) |
Mettez à jour les champs mutables pour une liste de jumeaux de module précédemment créés dans le système. |
| UpdateAsync(String, ClientTwin, Boolean, CancellationToken) |
Mises à jour les champs mutables du jumeau d’un module. |
| UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken) |
Mises à jour les champs mutables du jumeau d’un module. |
UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken)
Mettez à jour les champs mutables pour une liste de jumeaux de module précédemment créés dans le système.
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult> UpdateAsync (System.Collections.Generic.IEnumerable<Microsoft.Azure.Devices.ClientTwin> twins, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member UpdateAsync : seq<Microsoft.Azure.Devices.ClientTwin> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>
override this.UpdateAsync : seq<Microsoft.Azure.Devices.ClientTwin> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>Public Overridable Function UpdateAsync (twins As IEnumerable(Of ClientTwin), Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkRegistryOperationResult)Paramètres
- twins
- IEnumerable<ClientTwin>
Liste de ClientTwins avec des champs mis à jour.
- 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 l’identité d’appareil fournie a un ETag obsolète. Un ETag à jour peut être récupéré à l’aide de GetAsync(String, String, CancellationToken).
- cancellationToken
- CancellationToken
Jeton d’annulation de tâche.
Retours
mise à jour du jumeau de module.
Exceptions
Lorsque le fourni twins a la valeur Null.
Lorsque l’énumération fournie twins est vide.
Lorsqu’un jumeau manque un ETag attendu.
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.
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.
Si le fourni cancellationToken a demandé l’annulation.
S’applique à
UpdateAsync(String, ClientTwin, Boolean, CancellationToken)
Mises à jour les champs mutables du jumeau d’un module.
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin> UpdateAsync (string deviceId, Microsoft.Azure.Devices.ClientTwin twinPatch, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member UpdateAsync : string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>
override this.UpdateAsync : string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>Public Overridable Function UpdateAsync (deviceId As String, twinPatch As ClientTwin, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientTwin)Paramètres
- deviceId
- String
ID de l’appareil.
- twinPatch
- ClientTwin
Jumeau avec des champs mis à jour.
- 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 l’identité d’appareil fournie a un ETag obsolète. Un ETag à jour peut être récupéré à l’aide de GetAsync(String, String, CancellationToken).
- cancellationToken
- CancellationToken
Jeton d’annulation de tâche.
Retours
Jumeau d’appareil mis à jour.
Exceptions
Lorsque le fourni deviceId ou twinPatch est null.
Si est deviceId vide ou espace blanc.
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.
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.
Si le fourni cancellationToken a demandé l’annulation.
S’applique à
UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken)
Mises à jour les champs mutables du jumeau d’un module.
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin> UpdateAsync (string deviceId, string moduleId, Microsoft.Azure.Devices.ClientTwin twinPatch, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member UpdateAsync : string * string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>
override this.UpdateAsync : string * string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>Public Overridable Function UpdateAsync (deviceId As String, moduleId As String, twinPatch As ClientTwin, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientTwin)Paramètres
- deviceId
- String
ID de l’appareil.
- moduleId
- String
ID de module.
- twinPatch
- ClientTwin
Jumeau avec des champs mis à jour.
- 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 l’identité d’appareil/module fournie a un ETag obsolète. Un ETag à jour peut être récupéré à l’aide de GetAsync(String, String, CancellationToken).
- cancellationToken
- CancellationToken
Jeton d’annulation de tâche.
Retours
Jumeau d’appareil mis à jour.
Exceptions
Lorsque le fourni deviceId, moduleIdou twinPatch a la valeur Null.
Si ou deviceIdmoduleId est vide ou espace blanc.
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.
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.
Si le fourni cancellationToken a demandé l’annulation.
S’applique à
Azure SDK for .NET