TwinsClient.UpdateAsync 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
| UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken) |
Aktualisieren Sie die veränderlichen Felder für eine Liste der modulwilligen Zwillinge, die zuvor im System erstellt wurden. |
| UpdateAsync(String, ClientTwin, Boolean, CancellationToken) |
Updates die veränderlichen Felder des Zwillings eines Moduls. |
| UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken) |
Updates die veränderlichen Felder des Zwillings eines Moduls. |
UpdateAsync(IEnumerable<ClientTwin>, Boolean, CancellationToken)
Aktualisieren Sie die veränderlichen Felder für eine Liste der modulwilligen Zwillinge, die zuvor im System erstellt wurden.
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)Parameter
- twins
- IEnumerable<ClientTwin>
Liste der ClientTwins mit aktualisierten Feldern.
- onlyIfUnchanged
- Boolean
Bei false wird dieser Vorgang auch dann ausgeführt, wenn die bereitgestellte Geräteidentität über ein veraltetes ETag verfügt. Wenn true, löst der Vorgang ein mit PreconditionFailed ausIotHubServiceException, wenn die bereitgestellte Geräteidentität ein veraltetes ETag aufweist. Ein aktuelles ETag kann mit GetAsync(String, String, CancellationToken)abgerufen werden.
- cancellationToken
- CancellationToken
Vorgangsabbruchtoken.
Gibt zurück
Aktualisierter Modulzwilly.
Ausnahmen
Wenn das bereitgestellte twins null ist.
Wenn die bereitgestellte twins Enumeration leer ist.
Wenn einem Zwilling ein erwartetes ETag fehlt.
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 fehlschlägt, z. B. Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung.
Wenn der bereitgestellte cancellationToken einen Abbruch angefordert hat.
Gilt für:
UpdateAsync(String, ClientTwin, Boolean, CancellationToken)
Updates die veränderlichen Felder des Zwillings eines Moduls.
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)Parameter
- deviceId
- String
Die Geräte-ID.
- twinPatch
- ClientTwin
Zwilling mit aktualisierten Feldern.
- onlyIfUnchanged
- Boolean
Bei false wird dieser Vorgang auch dann ausgeführt, wenn die bereitgestellte Geräteidentität über ein veraltetes ETag verfügt. Wenn true, löst der Vorgang ein mit PreconditionFailed ausIotHubServiceException, wenn die bereitgestellte Geräteidentität ein veraltetes ETag aufweist. Ein aktuelles ETag kann mit GetAsync(String, String, CancellationToken)abgerufen werden.
- cancellationToken
- CancellationToken
Vorgangsabbruchtoken.
Gibt zurück
Aktualisierter Gerätezwilly.
Ausnahmen
Wenn das bereitgestellte deviceId oder twinPatch null ist.
Wenn leer deviceId oder leer 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 fehlschlägt, z. B. Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung.
Wenn der bereitgestellte cancellationToken einen Abbruch angefordert hat.
Gilt für:
UpdateAsync(String, String, ClientTwin, Boolean, CancellationToken)
Updates die veränderlichen Felder des Zwillings eines Moduls.
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)Parameter
- deviceId
- String
Die Geräte-ID.
- moduleId
- String
Die Modul-ID.
- twinPatch
- ClientTwin
Zwilling mit aktualisierten Feldern.
- onlyIfUnchanged
- Boolean
Bei false wird dieser Vorgang auch dann ausgeführt, wenn die bereitgestellte Geräteidentität über ein veraltetes ETag verfügt. Wenn true, löst der Vorgang ein mit PreconditionFailed ausIotHubServiceException, wenn die angegebene Geräte-/Modulidentität ein veraltetes ETag aufweist. Ein aktuelles ETag kann mit GetAsync(String, String, CancellationToken)abgerufen werden.
- cancellationToken
- CancellationToken
Vorgangsabbruchtoken.
Gibt zurück
Aktualisierter Gerätezwilly.
Ausnahmen
Wenn das angegebene deviceId, moduleIdoder twinPatch NULL ist.
Wenn oder deviceIdmoduleId leer oder leer 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 fehlschlägt, z. B. Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung.
Wenn der bereitgestellte cancellationToken einen Abbruch angefordert hat.
Gilt für:
Azure SDK for .NET