ModulesClient.SetAsync(Module, Boolean, CancellationToken) Methode

Referenz

Definition

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

Paket:: Microsoft.Azure.Devices v2.0.0-preview002

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.

Ersetzen Sie den Status einer Modulidentität durch den Zustand der bereitgestellten Modulidentität.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module> SetAsync(Microsoft.Azure.Devices.Module module, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member SetAsync : Microsoft.Azure.Devices.Module * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module>
override this.SetAsync : Microsoft.Azure.Devices.Module * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Module>

Public Overridable Function SetAsync (module As Module, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Module)

Parameter

module: Module

Der neue Zustand der Modulidentität.

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 das bereitgestellte Modul über ein veraltetes ETag verfügt. Ein aktuelles ETag kann mit GetAsync(String, String, CancellationToken)abgerufen werden.

cancellationToken: CancellationToken

Das Token, mit dem der Vorgang abgebrochen werden kann.

Gibt zurück

Task<Module>

Die neu aktualisierte Modulidentität einschließlich des neuen ETags.

Ausnahmen

ArgumentNullException

Wird ausgelöst, wenn das bereitgestellte Modul NULL ist.

IotHubServiceException

Wird ausgelöst, 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.

HttpRequestException

Wenn die HTTP-Anforderung aufgrund eines zugrunde liegenden Problems wie Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung fehlschlägt.

OperationCanceledException

Wenn das bereitgestellte Abbruchtoken den Abbruch angefordert hat.

Gilt für:

Freigeben über