JobClient.ScheduleTwinUpdateAsync Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v1.38.1

Overloads

ScheduleTwinUpdateAsync(String, String, Twin, DateTime, Int64)	Creates a new Job to update twin tags and desired properties on one or multiple devices
ScheduleTwinUpdateAsync(String, String, Twin, DateTime, Int64, CancellationToken)	Creates a new Job to update twin tags and desired properties on one or multiple devices

ScheduleTwinUpdateAsync(String, String, Twin, DateTime, Int64)

Creates a new Job to update twin tags and desired properties on one or multiple devices

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobResponse> ScheduleTwinUpdateAsync (string jobId, string queryCondition, Microsoft.Azure.Devices.Shared.Twin twin, DateTime startTimeUtc, long maxExecutionTimeInSeconds);

abstract member ScheduleTwinUpdateAsync : string * string * Microsoft.Azure.Devices.Shared.Twin * DateTime * int64 -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobResponse>
override this.ScheduleTwinUpdateAsync : string * string * Microsoft.Azure.Devices.Shared.Twin * DateTime * int64 -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobResponse>

Public Overridable Function ScheduleTwinUpdateAsync (jobId As String, queryCondition As String, twin As Twin, startTimeUtc As DateTime, maxExecutionTimeInSeconds As Long) As Task(Of JobResponse)

Parameters

jobId

String

Unique Job Id for this job

queryCondition

String

Query condition to evaluate which devices to run the job on

twin

Twin

Twin object to use for the update

startTimeUtc

DateTime

Date time in Utc to start the job

maxExecutionTimeInSeconds

Int64

Max execution time in seconds, i.e., ttl duration the job can run

Returns

Task<JobResponse>

A JobResponse object

ScheduleTwinUpdateAsync(String, String, Twin, DateTime, Int64, CancellationToken)

Creates a new Job to update twin tags and desired properties on one or multiple devices

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobResponse> ScheduleTwinUpdateAsync (string jobId, string queryCondition, Microsoft.Azure.Devices.Shared.Twin twin, DateTime startTimeUtc, long maxExecutionTimeInSeconds, System.Threading.CancellationToken cancellationToken);

abstract member ScheduleTwinUpdateAsync : string * string * Microsoft.Azure.Devices.Shared.Twin * DateTime * int64 * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobResponse>
override this.ScheduleTwinUpdateAsync : string * string * Microsoft.Azure.Devices.Shared.Twin * DateTime * int64 * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobResponse>

Public Overridable Function ScheduleTwinUpdateAsync (jobId As String, queryCondition As String, twin As Twin, startTimeUtc As DateTime, maxExecutionTimeInSeconds As Long, cancellationToken As CancellationToken) As Task(Of JobResponse)

Parameters

jobId

String

Unique Job Id for this job

queryCondition

String

Query condition to evaluate which devices to run the job on

twin

Twin

Twin object to use for the update

startTimeUtc

DateTime

Date time in Utc to start the job

maxExecutionTimeInSeconds

Int64

Max execution time in seconds, i.e., ttl duration the job can run

cancellationToken

CancellationToken

Task cancellation token

Returns

Task<JobResponse>

A JobResponse object