JobClient.ScheduleDeviceMethodAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
A JobResponse object
Applies to
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
A JobResponse object
