TwinsClient.ReplaceAsync Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Überlädt
| ReplaceAsync(String, ClientTwin, Boolean, CancellationToken) |
Updates die veränderlichen Felder des Gerätezwillers. |
| ReplaceAsync(String, String, ClientTwin, Boolean, CancellationToken) |
Updates die veränderlichen Felder des Zwillings eines Moduls. |
ReplaceAsync(String, ClientTwin, Boolean, CancellationToken)
Updates die veränderlichen Felder des Gerätezwillers.
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)Parameter
- deviceId
- String
Die Geräte-ID.
- newTwin
- ClientTwin
Neues Zwillingsobjekt, durch das ersetzt werden soll.
- onlyIfUnchanged
- Boolean
Wenn false, wird dieser Vorgang ausgeführt, auch wenn die bereitgestellte Geräteidentität ein veraltetes ETag aufweist. Wenn true, löst der Vorgang ein mit PreconditionFailed ausIotHubServiceException, wenn die angegebene Geräteidentität über ein veraltetes ETag verfügt. Ein aktuelles ETag kann mit GetAsync(String, String, CancellationToken)abgerufen werden.
- cancellationToken
- CancellationToken
Vorgangsabbruchtoken.
Gibt zurück
Zwillinge wurden aktualisiert.
Ausnahmen
Wenn das bereitgestellte deviceId oder newTwin null ist.
Wenn der bereitgestellte deviceId Leer- oder Leerraum ist.
Wenn IoT Hub auf die Anforderung mit einem nicht erfolgreichen status Code reagiert hat. Wenn beispielsweise die bereitgestellte Anforderung gedrosselt wurde, IotHubServiceException wird mit ThrottlingException ausgelöst. Eine vollständige Liste möglicher Fehlerfälle finden Sie unter IotHubServiceErrorCode.
Wenn die HTTP-Anforderung aufgrund eines zugrunde liegenden Problems wie Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung fehlschlägt.
Wenn die bereitgestellte cancellationToken kündigung angefordert hat.
Gilt für:
ReplaceAsync(String, String, ClientTwin, Boolean, CancellationToken)
Updates die veränderlichen Felder des Zwillings eines Moduls.
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)Parameter
- deviceId
- String
Die Geräte-ID.
- moduleId
- String
Die Modul-ID.
- newTwin
- ClientTwin
Neues Twin-Objekt, durch das ersetzt werden soll.
- onlyIfUnchanged
- Boolean
Wenn false, wird dieser Vorgang ausgeführt, auch wenn die bereitgestellte Geräteidentität ein veraltetes ETag aufweist. Wenn true, löst der Vorgang ein mit PreconditionFailed ausIotHubServiceException, wenn die angegebene Geräte-/Modulidentität über ein veraltetes ETag verfügt. Ein aktuelles ETag kann mit GetAsync(String, String, CancellationToken)abgerufen werden.
- cancellationToken
- CancellationToken
Vorgangsabbruchtoken.
Gibt zurück
Gerätezwille aktualisiert.
Ausnahmen
Wenn das angegebene deviceId, moduleIdoder newTwin null ist.
Wenn der bereitgestellte deviceId oder moduleId leer oder Leerraum ist.
Wenn IoT Hub auf die Anforderung mit einem nicht erfolgreichen status Code reagiert hat. Wenn beispielsweise die bereitgestellte Anforderung gedrosselt wurde, IotHubServiceException wird mit ThrottlingException ausgelöst. Eine vollständige Liste möglicher Fehlerfälle finden Sie unter IotHubServiceErrorCode.
Wenn die HTTP-Anforderung aufgrund eines zugrunde liegenden Problems wie Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung fehlschlägt.
Wenn die bereitgestellte cancellationToken kündigung angefordert hat.
Gilt für:
Azure SDK for .NET