JobClient.ScheduleDeviceMethodAsync Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v1.38.1

Overloads

ScheduleDeviceMethodAsync(String, String, CloudToDeviceMethod, DateTime, Int64)	Creates a new Job to run a device method on one or multiple devices
ScheduleDeviceMethodAsync(String, String, CloudToDeviceMethod, DateTime, Int64, CancellationToken)	Creates a new Job to run a device method on one or multiple devices

ScheduleDeviceMethodAsync(String, String, CloudToDeviceMethod, DateTime, Int64)

Creates a new Job to run a device method on one or multiple devices

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobResponse> ScheduleDeviceMethodAsync (string jobId, string queryCondition, Microsoft.Azure.Devices.CloudToDeviceMethod cloudToDeviceMethod, DateTime startTimeUtc, long maxExecutionTimeInSeconds);

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

Public Overridable Function ScheduleDeviceMethodAsync (jobId As String, queryCondition As String, cloudToDeviceMethod As CloudToDeviceMethod, 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

cloudToDeviceMethod

CloudToDeviceMethod

Method call parameters

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

ScheduleDeviceMethodAsync(String, String, CloudToDeviceMethod, DateTime, Int64, CancellationToken)

Creates a new Job to run a device method on one or multiple devices

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.JobResponse> ScheduleDeviceMethodAsync (string jobId, string queryCondition, Microsoft.Azure.Devices.CloudToDeviceMethod cloudToDeviceMethod, DateTime startTimeUtc, long maxExecutionTimeInSeconds, System.Threading.CancellationToken cancellationToken);

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

Public Overridable Function ScheduleDeviceMethodAsync (jobId As String, queryCondition As String, cloudToDeviceMethod As CloudToDeviceMethod, 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

cloudToDeviceMethod

CloudToDeviceMethod

Method call parameters

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