你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

JobClient class

参考

包:: azure-iothub

提供在 IoT 中心实例上创建、更新、监视和取消长时间运行的作业以及查询现有作业的方法。 Azure IoT 中心中的作业 API 允许在多个设备上计划直接方法调用和孪生更新。

SDK 用户应使用工厂方法 fromConnectionString(string) 和 fromSharedAccessSignature(string)创建 JobClient 实例。

方法

cancelJob(string \| number)
cancelJob(string \| number, TripleValueCallback<any, any>)	取消现有作业。
createQuery(JobType, JobStatus, number)	创建一个查询，该查询可用于基于类型和状态返回现有作业的页面。
fromConnectionString(string)	从给定连接字符串构造 JobClient 对象。
fromSharedAccessSignature(string)	从给定的共享访问签名构造 JobClient 对象。
fromTokenCredential(string, TokenCredential)	从给定的共享 Azure TokenCredential 构造 JobClient 对象。
getJob(string \| number)
getJob(string \| number, TripleValueCallback<any, any>)	请求有关现有作业的信息。
scheduleDeviceMethod(string \| number, string, DeviceMethodParams)
scheduleDeviceMethod(string \| number, string, DeviceMethodParams, Date)
scheduleDeviceMethod(string \| number, string, DeviceMethodParams, Date, number)
scheduleDeviceMethod(string \| number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)	计划将在一组设备上执行设备方法的作业。
scheduleDeviceMethod(string \| number, string, DeviceMethodParams, Date, TripleValueCallback<any, any>)
scheduleDeviceMethod(string \| number, string, DeviceMethodParams, TripleValueCallback<any, any>)
scheduleTwinUpdate(string \| number, string, any)
scheduleTwinUpdate(string \| number, string, any, Date)
scheduleTwinUpdate(string \| number, string, any, Date, number)
scheduleTwinUpdate(string \| number, string, any, Date, number, TripleValueCallback<any, any>)	计划一个作业，该作业将使用作为参数提供的修补程序更新一组孪生体。
scheduleTwinUpdate(string \| number, string, any, Date, TripleValueCallback<any, any>)
scheduleTwinUpdate(string \| number, string, any, TripleValueCallback<any, any>)

方法详细信息

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：Error 对象（可以为 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

封装适当（读取和/或写入）注册表权限的连接字符串。

JobClient

fromSharedAccessSignature(string)

从给定的共享访问签名构造 JobClient 对象。

static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient

参数

sharedAccessSignature: string

一个共享访问签名，它封装了适当的（读取和/或写入）注册表权限。

JobClient

fromTokenCredential(string, TokenCredential)

从给定的共享 Azure TokenCredential 构造 JobClient 对象。

static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): JobClient

参数

hostName: string

Azure 服务的主机名。

tokenCredential: TokenCredential

用于向 Azure 服务进行身份验证的 Azure TokenCredential

JobClient

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：Error 对象（可以为 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：Error 对象（可以为 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：Error 对象（可以为 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>

通过

JobClient class

方法

方法详细信息

cancelJob(string | number)

参数

返回

cancelJob(string | number, TripleValueCallback<any, any>)

参数

createQuery(JobType, JobStatus, number)

参数

返回

fromConnectionString(string)

参数

返回

fromSharedAccessSignature(string)

参数

返回

fromTokenCredential(string, TokenCredential)

参数

返回

getJob(string | number)

参数

返回

getJob(string | number, TripleValueCallback<any, any>)

参数

scheduleDeviceMethod(string | number, string, DeviceMethodParams)

参数

返回

scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date)

参数

返回

scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number)

参数

返回

scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)

参数

scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, TripleValueCallback<any, any>)

参数

scheduleDeviceMethod(string | number, string, DeviceMethodParams, TripleValueCallback<any, any>)

参数

scheduleTwinUpdate(string | number, string, any)

参数

返回

scheduleTwinUpdate(string | number, string, any, Date)

参数

返回

scheduleTwinUpdate(string | number, string, any, Date, number)

参数

返回

scheduleTwinUpdate(string | number, string, any, Date, number, TripleValueCallback<any, any>)

参数

scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)

参数

scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>)

参数

其他资源