ScheduledJobsClient.ScheduleTwinUpdateAsync 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.

Erstellt einen neuen Auftrag zum Aktualisieren von Zwillingstags und gewünschten Eigenschaften auf einem oder mehreren Geräten.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.TwinScheduledJob> ScheduleTwinUpdateAsync (string queryCondition, Microsoft.Azure.Devices.ClientTwin twin, DateTimeOffset startOnUtc, Microsoft.Azure.Devices.ScheduledJobsOptions scheduledJobsOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ScheduleTwinUpdateAsync : string * Microsoft.Azure.Devices.ClientTwin * DateTimeOffset * Microsoft.Azure.Devices.ScheduledJobsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.TwinScheduledJob>
override this.ScheduleTwinUpdateAsync : string * Microsoft.Azure.Devices.ClientTwin * DateTimeOffset * Microsoft.Azure.Devices.ScheduledJobsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.TwinScheduledJob>

Public Overridable Function ScheduleTwinUpdateAsync (queryCondition As String, twin As ClientTwin, startOnUtc As DateTimeOffset, Optional scheduledJobsOptions As ScheduledJobsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TwinScheduledJob)

Parameter

queryCondition: String

Abfragebedingung, um auszuwerten, auf welchen Geräten der Auftrag ausgeführt werden soll.

twin: ClientTwin

Zwillingsobjekt, das für das Update verwendet werden soll.

startOnUtc: DateTimeOffset

Wann der Auftrag in UTC gestartet werden soll.

scheduledJobsOptions: ScheduledJobsOptions

Optionale Parameter für geplante Zwillingsupdates, d. h.: scheduledJobsOptions.JobId.JobId und scheduledJobsOptions.MaxExecutionTimeInSeconds.MaxExecutionTimeInSeconds.

cancellationToken: CancellationToken

Vorgangsabbruchtoken.

Gibt zurück

Task<TwinScheduledJob>

Ein Auftragsobjekt.

Ausnahmen

ArgumentNullException

Wenn das bereitgestellte scheduledJobsOptions.JobId.JobId oder queryCondition oder twin oder startOnUtc oder scheduledJobsOptions.MaxExecutionTimeInSeconds.MaxExecutionTimeInSeconds null ist.

ArgumentException

Wenn oder scheduledJobsOptions.JobId.JobIdqueryCondition leer oder leer ist.

IotHubServiceException

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 fehlschlägt, z. B. Netzwerkkonnektivität, DNS-Fehler oder Serverzertifikatüberprüfung.

OperationCanceledException

Wenn der bereitgestellte cancellationToken einen Abbruch angefordert hat.

Gilt für:

Freigeben über