JobClient class

Csomag:

azure-iothub

Metódusokat biztosít a hosszú ideig futó feladatok létrehozására, frissítésére, monitorozására és megszakítására egy IoT Hub példányon, valamint lekérdezheti a meglévő feladatokat. A Azure IoT Hub Jobs API-ja lehetővé teszi közvetlen metódushívások és ikerfrissítések ütemezését több eszközön.

Az SDK-felhasználóknak a és a gyári metódusokkal fromConnectionString(string)fromSharedAccessSignature(string)kell létrehozniuk JobClient példányokat.

Metódusok

cancelJob(string | number)
cancelJob(string | number, TripleValueCallback<any, any>)	Megszakít egy meglévő feladatot.
createQuery(JobType, JobStatus, number)	Létrehoz egy lekérdezést, amely a meglévő feladat lapjainak visszaadására használható típus és állapot alapján.
fromConnectionString(string)	Létrehoz egy JobClient objektumot az adott kapcsolati sztring.
fromSharedAccessSignature(string)	Létrehoz egy JobClient objektumot a megadott közös hozzáférésű jogosultságkódból.
fromTokenCredential(string, TokenCredential)	Létrehoz egy JobClient objektumot a megadott megosztott Azure TokenCredentialból.
getJob(string | number)
getJob(string | number, TripleValueCallback<any, any>)	Információt kér egy meglévő feladatról.
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>)	Ütemez egy feladatot, amely eszközmetódust hajt végre egy eszközkészleten.
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>)	Ütemezzen egy feladatot, amely egy ikerpéldány-készletet frissít a paraméterként megadott javítással.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>)

Metódus adatai

cancelJob(string | number)

function cancelJob(jobId: string | number): Promise<JobStatusResponse>

Paraméterek

jobId

string | number

Válaszok

Promise<JobStatusResponse>

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

Megszakít egy meglévő feladatot.

function cancelJob(jobId: string | number, done?: TripleValueCallback<any, any>)

Paraméterek

jobId

string | number

Egy meglévő feladat azonosítója.

done

TripleValueCallback<any, any>

A művelet befejezésekor meghívandó nem kötelező függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), feladatobjektum és átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

createQuery(JobType, JobStatus, number)

Létrehoz egy lekérdezést, amely a meglévő feladat lapjainak visszaadására használható típus és állapot alapján.

function createQuery(jobType?: JobType, jobStatus?: JobStatus, pageSize?: number): Query

Paraméterek

jobType

JobType

Az eredmények szűréséhez használandó típus.

jobStatus

JobStatus

Az eredmények szűréséhez használandó állapot.

pageSize

number

Az oldalanként visszaadandó elemek száma.

Válaszok

Query

fromConnectionString(string)

Létrehoz egy JobClient objektumot az adott kapcsolati sztring.

static function fromConnectionString(connectionString: string): JobClient

Paraméterek

connectionString

string

A megfelelő (olvasási és/vagy írási) beállításjegyzék-engedélyeket tartalmazó kapcsolati sztring.

Válaszok

JobClient

fromSharedAccessSignature(string)

Létrehoz egy JobClient objektumot a megadott közös hozzáférésű jogosultságkódból.

static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient

Paraméterek

sharedAccessSignature

string

Közös hozzáférésű jogosultságkód, amely tartalmazza a megfelelő (olvasási és/vagy írási) beállításjegyzék-engedélyeket.

Válaszok

JobClient

fromTokenCredential(string, TokenCredential)

Létrehoz egy JobClient objektumot a megadott megosztott Azure TokenCredentialból.

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

Paraméterek

hostName

string

Az Azure-szolgáltatás állomásneve.

tokenCredential

TokenCredential

Az Azure-szolgáltatással való hitelesítéshez használt Azure TokenCredential

Válaszok

JobClient

getJob(string | number)

function getJob(jobId: string | number): Promise<JobStatusResponse>

Paraméterek

jobId

string | number

Válaszok

Promise<JobStatusResponse>

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

Információt kér egy meglévő feladatról.

function getJob(jobId: string | number, done?: TripleValueCallback<any, any>)

Paraméterek

jobId

string | number

Egy meglévő feladat azonosítója.

done

TripleValueCallback<any, any>

A művelet befejezésekor meghívandó nem kötelező függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), feladatobjektum és átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

scheduleDeviceMethod(string | number, string, DeviceMethodParams)

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams): Promise<JobStatusResponse>

Paraméterek

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

Válaszok

Promise<JobStatusResponse>

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

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date): Promise<JobStatusResponse>

Paraméterek

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

jobStartTime

Date

Válaszok

Promise<JobStatusResponse>

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

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, maxExecutionTimeInSeconds: number): Promise<JobStatusResponse>

Paraméterek

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

jobStartTime

Date

maxExecutionTimeInSeconds

number

Válaszok

Promise<JobStatusResponse>

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

Ütemez egy feladatot, amely eszközmetódust hajt végre egy eszközkészleten.

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)

Paraméterek

jobId

string | number

A feladathoz használandó egyedi azonosító.

queryCondition

string

Egy SQL-lekérdezés WHERE záradéka azon eszközök listájának kiszámításához, amelyeken a feladatot futtatni kell.

methodParams

DeviceMethodParams

A metódust leíró objektumnak a következő tulajdonságokkal kell rendelkeznie: - methodName A meghívandó metódus neve. - hasznos adat [nem kötelező] A metódushíváshoz használandó hasznos adat. - responseTimeoutInSeconds [nem kötelező] A IoT Hub másodpercek száma az eszközre vár

jobStartTime

Date

A feladat indításának időpontja

maxExecutionTimeInSeconds

number

A feladat maximális futási ideje másodpercben.

done

TripleValueCallback<any, any>

A művelet befejezésekor meghívandó nem kötelező függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), feladatobjektum és átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

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

function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, done: TripleValueCallback<any, any>)

Paraméterek

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>)

Paraméterek

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>

Paraméterek

jobId

string | number

queryCondition

string

patch

any

Válaszok

Promise<JobStatusResponse>

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

function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date): Promise<JobStatusResponse>

Paraméterek

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

Válaszok

Promise<JobStatusResponse>

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

function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, maxExecutionTimeInSeconds?: number): Promise<JobStatusResponse>

Paraméterek

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

maxExecutionTimeInSeconds

number

Válaszok

Promise<JobStatusResponse>

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

Ütemezzen egy feladatot, amely egy ikerpéldány-készletet frissít a paraméterként megadott javítással.

function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)

Paraméterek

jobId

string | number

A feladathoz használandó egyedi azonosító.

queryCondition

string

Egy SQL-lekérdezés WHERE záradéka azon eszközök listájának kiszámításához, amelyeken a feladatot futtatni kell.

patch

any

Az ikerpéldányokra alkalmazandó ikerjavítás.

jobStartTime

Date

A feladat indításának időpontja

maxExecutionTimeInSeconds

number

A feladat maximális futási ideje másodpercben.

done

TripleValueCallback<any, any>

A művelet befejezésekor meghívandó nem kötelező függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), feladatobjektum és átvitelspecifikus válaszobjektum, amely naplózáshoz vagy hibakereséshez használható.

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

function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, done: TripleValueCallback<any, any>)

Paraméterek

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>)

Paraméterek

jobId

string | number

queryCondition

string

patch

any

done

TripleValueCallback<any, any>