Megosztás a következőn keresztül:


JobClient class

Metódusokat biztosít egy IoT Hub-példányon futó, hosszú ideig futó feladatok létrehozására, frissítésére, monitorozására és megszakítására, valamint a meglévő feladatok lekérdezésére. Az 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ók várhatóan JobClient példányokat hoznak létre a gyári metódusokkal fromConnectionString(string) és fromSharedAccessSignature(string).

Metódusok

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

Egy meglévő feladat megszakítása.

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)

Egy JobClient-objektumot hoz létre a megadott kapcsolati sztringből.

fromSharedAccessSignature(string)

Egy JobClient-objektumot hoz létre a megadott közös hozzáférésű jogosultságkódból.

fromTokenCredential(string, TokenCredential)

Egy JobClient-objektumot hoz létre az adott 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ódusokat 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 paraméterként megadott javítással frissíti az ikerpéldányokat.

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

Egy meglévő feladat megszakítása.

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 hívandó opcionális függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), feladatobjektum és a naplózáshoz vagy hibakereséshez hasznos átvitelspecifikus válaszobjektum.

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 oldalonként visszaadandó elemek száma.

Válaszok

Query

fromConnectionString(string)

Egy JobClient-objektumot hoz létre a megadott kapcsolati sztringből.

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

fromSharedAccessSignature(string)

Egy JobClient-objektumot hoz létre 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 magában foglalja a megfelelő (olvasási és/vagy írási) beállításjegyzék-engedélyeket.

Válaszok

fromTokenCredential(string, TokenCredential)

Egy JobClient-objektumot hoz létre az adott 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

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 hívandó opcionális függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), feladatobjektum és a naplózáshoz vagy hibakereséshez hasznos átvitelspecifikus válaszobjektum.

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ódusokat 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

Sql-lekérdezés WHERE záradéka azon eszközök listájának kiszámításához, amelyeken ezt 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ő] Az IoT Hubnak várnia kell az eszközre

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 hívandó opcionális függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), feladatobjektum és a naplózáshoz vagy hibakereséshez hasznos átvitelspecifikus válaszobjektum.

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 paraméterként megadott javítással frissíti az ikerpéldányokat.

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

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

patch

any

Az ikerjavítás, amelyet az ikerpéldányokra kell alkalmazni.

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 hívandó opcionális függvény. done három argumentummal lesz meghívva: hibaobjektum (lehet null), feladatobjektum és a naplózáshoz vagy hibakereséshez hasznos átvitelspecifikus válaszobjektum.

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>