JobClient class

Balíček:

azure-iothub

Poskytuje metody pro vytváření, aktualizaci, monitorování a rušení dlouhotrvajících úloh v instanci IoT Hub a dotazování existujících úloh. Rozhraní API pro úlohy v Azure IoT Hub umožňuje plánovat volání přímých metod a aktualizace dvojčat na více zařízeních.

Očekává se, že uživatelé sady SDK budou vytvářet JobClient instance pomocí metod fromConnectionString(string) z výroby a fromSharedAccessSignature(string).

Metody

cancelJob(string | number)
cancelJob(string | number, TripleValueCallback<any, any>)	Zruší existující úlohu.
createQuery(JobType, JobStatus, number)	Vytvoří dotaz, který lze použít k vrácení stránek existující úlohy na základě typu a stavu.
fromConnectionString(string)	Vytvoří objekt JobClient z daného připojovacího řetězce.
fromSharedAccessSignature(string)	Vytvoří objekt JobClient z daného sdíleného přístupového podpisu.
fromTokenCredential(string, TokenCredential)	Vytvoří objekt JobClient z daného sdíleného tokenu AzureCredential.
getJob(string | number)
getJob(string | number, TripleValueCallback<any, any>)	Vyžádá si informace o existující úloze.
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>)	Naplánuje úlohu, která spustí metodu zařízení na sadě zařízení.
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>)	Naplánujte úlohu, která aktualizuje sadu dvojčat pomocí opravy poskytnuté jako parametr.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>)

Podrobnosti metody

cancelJob(string | number)

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

Parametry

jobId

string | number

Návraty

Promise<JobStatusResponse>

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

Zruší existující úlohu.

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

Parametry

jobId

string | number

Identifikátor existující úlohy.

done

TripleValueCallback<any, any>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), objekt úlohy a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

createQuery(JobType, JobStatus, number)

Vytvoří dotaz, který lze použít k vrácení stránek existující úlohy na základě typu a stavu.

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

Parametry

jobType

JobType

Typ, který se má použít k filtrování výsledků.

jobStatus

JobStatus

Stav, který by se měl použít k filtrování výsledků.

pageSize

number

Počet prvků, které se mají vrátit na stránku.

Návraty

Query

fromConnectionString(string)

Vytvoří objekt JobClient z daného připojovacího řetězce.

static function fromConnectionString(connectionString: string): JobClient

Parametry

connectionString

string

Připojovací řetězec, který zapouzdřuje příslušná oprávnění registru (čtení nebo zápis).

Návraty

JobClient

fromSharedAccessSignature(string)

Vytvoří objekt JobClient z daného sdíleného přístupového podpisu.

static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient

Parametry

sharedAccessSignature

string

Sdílený přístupový podpis, který zapouzdřuje příslušná oprávnění registru (čtení nebo zápis).

Návraty

JobClient

fromTokenCredential(string, TokenCredential)

Vytvoří objekt JobClient z daného sdíleného tokenu AzureCredential.

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

Parametry

hostName

string

Název hostitele služby Azure.

tokenCredential

TokenCredential

Přihlašovací údaje tokenu Azure sloužící k ověření ve službě Azure

Návraty

JobClient

getJob(string | number)

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

Parametry

jobId

string | number

Návraty

Promise<JobStatusResponse>

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

Vyžádá si informace o existující úloze.

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

Parametry

jobId

string | number

Identifikátor existující úlohy.

done

TripleValueCallback<any, any>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), objekt úlohy a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

scheduleDeviceMethod(string | number, string, DeviceMethodParams)

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

Parametry

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

Návraty

Promise<JobStatusResponse>

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

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

Parametry

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

jobStartTime

Date

Návraty

Promise<JobStatusResponse>

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

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

Parametry

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

jobStartTime

Date

maxExecutionTimeInSeconds

number

Návraty

Promise<JobStatusResponse>

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

Naplánuje úlohu, která spustí metodu zařízení na sadě zařízení.

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

Parametry

jobId

string | number

Jedinečný identifikátor, který by měl být použit pro tuto úlohu.

queryCondition

string

Klauzule WHERE dotazu SQL, která slouží k výpočtu seznamu zařízení, na kterých se má tato úloha spustit.

methodParams

DeviceMethodParams

Objekt popisující metodu a musí mít následující vlastnosti: - methodName Název metody, která má být vyvolána. – payload [volitelné] Datová část, která se má použít pro volání metody. - responseTimeoutInSeconds [volitelné] Počet sekund, IoT Hub musí čekat na zařízení

jobStartTime

Date

Čas, kdy by se měla úloha spustit

maxExecutionTimeInSeconds

number

Maximální doba, po kterou má tato úloha běžet v sekundách.

done

TripleValueCallback<any, any>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), objekt úlohy a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

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

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

Parametry

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

Parametry

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>

Parametry

jobId

string | number

queryCondition

string

patch

any

Návraty

Promise<JobStatusResponse>

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

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

Parametry

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

Návraty

Promise<JobStatusResponse>

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

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

Parametry

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

maxExecutionTimeInSeconds

number

Návraty

Promise<JobStatusResponse>

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

Naplánujte úlohu, která aktualizuje sadu dvojčat pomocí opravy poskytnuté jako parametr.

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

Parametry

jobId

string | number

Jedinečný identifikátor, který by měl být použit pro tuto úlohu.

queryCondition

string

Klauzule WHERE dotazu SQL, která slouží k výpočtu seznamu zařízení, na kterých se má tato úloha spustit.

patch

any

Oprava dvojčete, která by se měla použít na dvojčata.

jobStartTime

Date

Čas, kdy by se měla úloha spustit

maxExecutionTimeInSeconds

number

Maximální doba, po kterou má tato úloha běžet v sekundách.

done

TripleValueCallback<any, any>

Volitelná funkce, která se má volat po dokončení operace. done bude volána se třemi argumenty: objekt Error (může mít hodnotu null), objekt úlohy a objekt odpovědi specifický pro přenos, který je užitečný pro protokolování nebo ladění.

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

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

Parametry

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

Parametry

jobId

string | number

queryCondition

string

patch

any

done

TripleValueCallback<any, any>