你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
JobClient class
提供在 IoT 中心 实例上创建、更新、监视和取消长时间运行的作业以及查询现有作业的方法。 Azure IoT 中心 中的作业 API 允许在多个设备上计划直接方法调用和孪生更新。
SDK 用户应使用工厂方法和 fromConnectionString(string)fromSharedAccessSignature(string)创建JobClient实例。
方法
方法详细信息
cancelJob(string | number)
function cancelJob(jobId: string | number): Promise<JobStatusResponse>参数
- jobId
-
string | number
返回
Promise<JobStatusResponse>
cancelJob(string | number, TripleValueCallback<any, any>)
取消现有作业。
function cancelJob(jobId: string | number, done?: TripleValueCallback<any, any>)参数
- jobId
-
string | number
现有作业的标识符。
- done
-
TripleValueCallback<any, any>
操作完成时要调用的可选函数。 done 将使用三个参数调用：错误对象 (可以为 null) 、作业对象和用于日志记录或调试的特定于传输的响应对象。
createQuery(JobType, JobStatus, number)
创建一个查询，该查询可用于根据类型和状态返回现有作业的页面。
function createQuery(jobType?: JobType, jobStatus?: JobStatus, pageSize?: number): Query参数
- jobType
-
JobType
应用于筛选结果的类型。
- jobStatus
-
JobStatus
应用于筛选结果的状态。
- pageSize
-
number
每页要返回的元素数。
返回
Query
fromConnectionString(string)
从给定的连接字符串构造 JobClient 对象。
static function fromConnectionString(connectionString: string): JobClient参数
- connectionString
-
string
一个连接字符串，用于封装相应的 (读取和/或写入) 注册表权限。
返回
fromSharedAccessSignature(string)
根据给定的共享访问签名构造 JobClient 对象。
static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient参数
- sharedAccessSignature
-
string
一种共享访问签名，用于封装注册表权限) 读取和/或写入的相应 (。
返回
fromTokenCredential(string, TokenCredential)
从给定的共享 Azure TokenCredential 构造 JobClient 对象。
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): JobClient参数
- hostName
-
string
Azure 服务的主机名。
- tokenCredential
- TokenCredential
用于通过 Azure 服务进行身份验证的 Azure TokenCredential
返回
getJob(string | number)
function getJob(jobId: string | number): Promise<JobStatusResponse>参数
- jobId
-
string | number
返回
Promise<JobStatusResponse>
getJob(string | number, TripleValueCallback<any, any>)
请求有关现有作业的信息。
function getJob(jobId: string | number, done?: TripleValueCallback<any, any>)参数
- jobId
-
string | number
现有作业的标识符。
- done
-
TripleValueCallback<any, any>
操作完成时要调用的可选函数。 done 将使用三个参数调用：错误对象 (可以为 null) 、作业对象和用于日志记录或调试的特定于传输的响应对象。
scheduleDeviceMethod(string | number, string, DeviceMethodParams)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams): Promise<JobStatusResponse>参数
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
返回
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date): Promise<JobStatusResponse>参数
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
返回
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, maxExecutionTimeInSeconds: number): Promise<JobStatusResponse>参数
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
- maxExecutionTimeInSeconds
-
number
返回
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)
计划将在一组设备上执行设备方法的作业。
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)参数
- jobId
-
string | number
应用于此作业的唯一标识符。
- queryCondition
-
string
SQL 查询 WHERE 子句，用于计算应运行此作业的设备列表。
- methodParams
- DeviceMethodParams
描述 方法的对象，应具有以下属性： - methodName 应调用的方法的名称。 - 有效负载 [可选] 要用于方法调用的有效负载。 - responseTimeoutInSeconds [可选] IoT 中心应等待设备的秒数
- jobStartTime
-
Date
作业应启动的时间
- maxExecutionTimeInSeconds
-
number
分配的此作业运行的最长时间（以秒为单位）。
- done
-
TripleValueCallback<any, any>
操作完成时要调用的可选函数。 done 将使用三个参数调用：错误对象 (可以为 null) 、作业对象和用于日志记录或调试的特定于传输的响应对象。
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, TripleValueCallback<any, any>)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, done: TripleValueCallback<any, any>)参数
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
- done
-
TripleValueCallback<any, any>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, TripleValueCallback<any, any>)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, done: TripleValueCallback<any, any>)参数
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- done
-
TripleValueCallback<any, any>
scheduleTwinUpdate(string | number, string, any)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any): Promise<JobStatusResponse>参数
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
返回
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date): Promise<JobStatusResponse>参数
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
返回
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, maxExecutionTimeInSeconds?: number): Promise<JobStatusResponse>参数
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
- maxExecutionTimeInSeconds
-
number
返回
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number, TripleValueCallback<any, any>)
计划一个作业，该作业将使用作为参数提供的修补程序更新一组孪生体。
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)参数
- jobId
-
string | number
应用于此作业的唯一标识符。
- queryCondition
-
string
SQL 查询 WHERE 子句，用于计算应运行此作业的设备列表。
- patch
-
any
应应用于孪生体的孪生体修补程序。
- jobStartTime
-
Date
作业应启动的时间
- maxExecutionTimeInSeconds
-
number
分配的此作业运行的最长时间（以秒为单位）。
- done
-
TripleValueCallback<any, any>
操作完成时要调用的可选函数。 done 将使用三个参数调用：错误对象 (可以为 null) 、作业对象和用于日志记录或调试的特定于传输的响应对象。
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, done: TripleValueCallback<any, any>)参数
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
- done
-
TripleValueCallback<any, any>
scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, done: TripleValueCallback<any, any>)参数
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- done
-
TripleValueCallback<any, any>