JobClient class
IoT Hub インスタンスで実行時間の長いジョブの作成、更新、監視、取り消し、既存のジョブのクエリを実行するメソッドを提供します。 Azure IoT Hubの Jobs API を使用すると、複数のデバイスで直接メソッド呼び出しとツイン更新をスケジュールできます。
SDK ユーザーは、ファクトリ メソッド と fromSharedAccessSignature(string)を使用してインスタンスを作成JobClientする必要がありますfromConnectionString(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 を指定できます)、ジョブ オブジェクト、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
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 を指定できます)、ジョブ オブジェクト、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
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 Hubデバイスを待機する秒数
- jobStartTime
-
Date
ジョブを開始する時刻
- maxExecutionTimeInSeconds
-
number
このジョブの実行に割り当てられた最大時間 (秒単位)。
- done
-
TripleValueCallback<any, any>
操作が完了したときに呼び出す省略可能な関数。 done は、Error オブジェクト (null を指定できます)、ジョブ オブジェクト、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
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 を指定できます)、ジョブ オブジェクト、およびログ記録またはデバッグに役立つトランスポート固有の応答オブジェクトの 3 つの引数で呼び出されます。
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>