DevicesClient.SetAsync 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
SetAsync(Device, Boolean, CancellationToken) |
Ersetzen Sie den Zustand einer Geräteidentität durch den Zustand der bereitgestellten Geräteidentität. |
SetAsync(IEnumerable<Device>, Boolean, CancellationToken) |
Aktualisieren Sie bis zu 100 Geräteidentitäten in der Registrierung Ihres IoT Hubs in massenhaft. |
SetAsync(Device, Boolean, CancellationToken)
Ersetzen Sie den Zustand einer Geräteidentität durch den Zustand der bereitgestellten Geräteidentität.
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.Device> SetAsync (Microsoft.Azure.Devices.Device device, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);
abstract member SetAsync : Microsoft.Azure.Devices.Device * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Device>
override this.SetAsync : Microsoft.Azure.Devices.Device * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Device>
Public Overridable Function SetAsync (device As Device, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Device)
Parameter
- device
- Device
Der neue Zustand der Geräteidentität.
- onlyIfUnchanged
- Boolean
Wenn false, wird dieser Aktualisierungsvorgang ausgeführt, auch wenn die angegebene Geräteidentität über ein veraltetes ETag verfügt. 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, CancellationToken)abgerufen werden.
- cancellationToken
- CancellationToken
Das Token, mit dem der Vorgang abgebrochen werden kann.
Gibt zurück
Die neu aktualisierte Geräteidentität einschließlich des neuen ETags.
Ausnahmen
Wenn das bereitgestellte Gerät NULL 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 das bereitgestellte Abbruchtoken den Abbruch angefordert hat.
Gilt für:
SetAsync(IEnumerable<Device>, Boolean, CancellationToken)
Aktualisieren Sie bis zu 100 Geräteidentitäten in der Registrierung Ihres IoT Hubs in massenhaft.
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult> SetAsync (System.Collections.Generic.IEnumerable<Microsoft.Azure.Devices.Device> devices, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);
abstract member SetAsync : seq<Microsoft.Azure.Devices.Device> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>
override this.SetAsync : seq<Microsoft.Azure.Devices.Device> * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.BulkRegistryOperationResult>
Public Overridable Function SetAsync (devices As IEnumerable(Of Device), Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of BulkRegistryOperationResult)
Parameter
- devices
- IEnumerable<Device>
Die Geräteidentitäten, die in die Registrierung Ihres IoT Hubs aktualisiert werden sollen. Darf 100 Geräte nicht überschreiten.
- onlyIfUnchanged
- Boolean
Wenn false, wird dieser Aktualisierungsvorgang ausgeführt, auch wenn die angegebene Geräteidentität über ein veraltetes ETag verfügt. 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, CancellationToken)abgerufen werden.
- cancellationToken
- CancellationToken
Das Token, mit dem der Vorgang abgebrochen werden kann.
Gibt zurück
Das Ergebnis des Massenvorgangs.
Ausnahmen
Wenn die angegebene Gerätesammlung NULL ist.
Wenn die bereitgestellte Gerätesammlung 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 wie Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung fehlschlägt.
Wenn das bereitgestellte Abbruchtoken den Abbruch angefordert hat.
Gilt für:
Azure SDK for .NET