TwinsClient.ReplaceAsync 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
| ReplaceAsync(String, ClientTwin, Boolean, CancellationToken) |
Mises à jour les champs mutables du jumeau d’un appareil. |
| ReplaceAsync(String, String, ClientTwin, Boolean, CancellationToken) |
Mises à jour les champs mutables du jumeau d’un module. |
ReplaceAsync(String, ClientTwin, Boolean, CancellationToken)
Mises à jour les champs mutables du jumeau d’un appareil.
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin> ReplaceAsync (string deviceId, Microsoft.Azure.Devices.ClientTwin newTwin, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member ReplaceAsync : string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>
override this.ReplaceAsync : string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>Public Overridable Function ReplaceAsync (deviceId As String, newTwin As ClientTwin, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientTwin)Paramètres
- deviceId
- String
ID de l’appareil.
- newTwin
- ClientTwin
Nouvel objet de jumeau par lequel remplacer.
- 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
jumeaux mis à jour.
Exceptions
Lorsque le fourni deviceId ou newTwin est null.
Lorsque le fourni deviceId est vide ou 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 à
ReplaceAsync(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> ReplaceAsync (string deviceId, string moduleId, Microsoft.Azure.Devices.ClientTwin newTwin, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member ReplaceAsync : string * string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>
override this.ReplaceAsync : string * string * Microsoft.Azure.Devices.ClientTwin * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ClientTwin>Public Overridable Function ReplaceAsync (deviceId As String, moduleId As String, newTwin 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.
- newTwin
- ClientTwin
Nouvel objet Twin par lequel remplacer.
- 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 newTwin a la valeur Null.
Lorsque le fourni deviceId ou moduleId 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