ScheduledJobsClient.ScheduleDirectMethodAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Devices

Assembly:: Microsoft.Azure.Devices.dll

Package:: Microsoft.Azure.Devices v2.0.0-preview002

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.

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

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob> ScheduleDirectMethodAsync (string queryCondition, Microsoft.Azure.Devices.DirectMethodServiceRequest directMethodRequest, DateTimeOffset startOnUtc, Microsoft.Azure.Devices.ScheduledJobsOptions scheduledJobsOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member ScheduleDirectMethodAsync : string * Microsoft.Azure.Devices.DirectMethodServiceRequest * DateTimeOffset * Microsoft.Azure.Devices.ScheduledJobsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob>
override this.ScheduleDirectMethodAsync : string * Microsoft.Azure.Devices.DirectMethodServiceRequest * DateTimeOffset * Microsoft.Azure.Devices.ScheduledJobsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.ScheduledJob>

Public Overridable Function ScheduleDirectMethodAsync (queryCondition As String, directMethodRequest As DirectMethodServiceRequest, startOnUtc As DateTimeOffset, scheduledJobsOptions As ScheduledJobsOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ScheduledJob)

Parameters

queryCondition: String

Query condition to evaluate which devices the job applies to.

directMethodRequest: DirectMethodServiceRequest

Method call parameters.

startOnUtc: DateTimeOffset

When to start the job in UTC.

scheduledJobsOptions: ScheduledJobsOptions

Optional parameters for scheduled device method, i.e: scheduledJobsOptions.JobId.JobId and scheduledJobsOptions.MaxExecutionTimeInSeconds.MaxExecutionTimeInSeconds.

cancellationToken: CancellationToken

Task cancellation token.

Returns

Task<ScheduledJob>

A job object.

Exceptions

ArgumentNullException

When the provided scheduledJobsOptions.JobId.JobId or queryCondition or startOnUtc is null.

ArgumentException

If the scheduledJobsOptions.JobId.JobId or queryCondition is empty or white space.

IotHubServiceException

If IoT hub responded to the request with a non-successful status code. For example, if the provided request was throttled, IotHubServiceException with ThrottlingException is thrown. For a complete list of possible error cases, see IotHubServiceErrorCode.

HttpRequestException

If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.

OperationCanceledException

If the provided cancellationToken has requested cancellation.

Applies to

Aracılığıyla paylaş