JobClient class
提供在IoT中樞實例上建立、更新、監視和取消長時間執行的作業，以及查詢現有作業的方法。 Azure IoT 中樞中的作業 API 允許在多個裝置上排程直接方法呼叫和對應項更新。
SDK 使用者應該使用處理站方法來建立 JobClient 實體，fromConnectionString(string) 和 fromSharedAccessSignature(string)。
方法
方法詳細資料
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
連接字串，封裝適當的登錄許可權（讀取和/或寫入）。
傳回
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 會使用三個自變數來呼叫：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>