ScheduledJobsClient.ScheduleTwinUpdateAsync メソッド

定義

名前空間:

Microsoft.Azure.Devices

アセンブリ:

Microsoft.Azure.Devices.dll

パッケージ:

Microsoft.Azure.Devices v2.0.0-preview002

1 つまたは複数のデバイスでツイン タグと必要なプロパティを更新する新しいジョブを作成します。

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)

パラメーター

queryCondition

String

ジョブを実行するデバイスを評価するためのクエリ条件。

twin

ClientTwin

更新に使用するツイン オブジェクト。

startOnUtc

DateTimeOffset

ジョブを開始するタイミング (UTC)。

scheduledJobsOptions

ScheduledJobsOptions

スケジュールされたツイン更新の省略可能なパラメーター (つまり、 scheduledJobsOptions.JobId.JobId と scheduledJobsOptions.MaxExecutionTimeInSeconds.MaxExecutionTimeInSeconds)。

cancellationToken

CancellationToken

タスクの取り消しトークン。

戻り値

Task<TwinScheduledJob>

ジョブ オブジェクト。

例外

ArgumentNullException

指定 scheduledJobsOptions.JobId.JobId された または または queryCondition または twinstartOnUtcscheduledJobsOptions.MaxExecutionTimeInSeconds.MaxExecutionTimeInSeconds が null の場合。

ArgumentException

scheduledJobsOptions.JobId.JobIdまたは queryCondition が空または空白の場合。

IotHubServiceException

IoT ハブが失敗した状態コードで要求に応答した場合。 たとえば、指定された要求が調整された場合、 IotHubServiceException が ThrottlingException スローされます。 考えられるエラー ケースの完全な一覧については、「」を参照してください IotHubServiceErrorCode。

HttpRequestException

ネットワーク接続、DNS エラー、サーバー証明書の検証などの根本的な問題が原因で HTTP 要求が失敗した場合。

OperationCanceledException

指定 cancellationToken された がキャンセルを要求した場合。