Dela via

JobClient class

Paket:
azure-iothub

Innehåller metoder för att skapa, uppdatera, övervaka och avbryta långvariga jobb på en IoT Hub-instans samt köra frågor mot befintliga jobb. Med jobb-API:et i Azure IoT Hub kan du schemalägga direktmetodanrop och tvillinguppdateringar på flera enheter.

SDK-användare förväntas skapa JobClient instanser med hjälp av fabriksmetoderna fromConnectionString(string) och fromSharedAccessSignature(string).

Metoder

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

Avbryter ett befintligt jobb.
createQuery(JobType, JobStatus, number)

Skapar en fråga som kan användas för att returnera sidor med ett befintligt jobb baserat på typ och status.
fromConnectionString(string)

Konstruerar ett JobClient-objekt från den angivna anslutningssträngen.
fromSharedAccessSignature(string)

Konstruerar ett JobClient-objekt från den angivna signaturen för delad åtkomst.
fromTokenCredential(string, TokenCredential)

Konstruerar ett JobClient-objekt från den angivna delade Azure TokenCredential.
getJob(string | number)
getJob(string | number, TripleValueCallback<any, any>)

Begär information om ett befintligt jobb.
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>)

Schemalägger ett jobb som ska köra en enhetsmetod på en uppsättning enheter.
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>)

Schemalägg ett jobb som uppdaterar en uppsättning tvillingar med korrigeringen som tillhandahålls som en parameter.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>)

Metodinformation

cancelJob(string | number) 

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

Parametrar

jobId

string | number

Returer

Promise<JobStatusResponse>

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

Avbryter ett befintligt jobb.

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

Parametrar

jobId

string | number

Identifieraren för ett befintligt jobb.

done

TripleValueCallback<any, any>

Den valfria funktionen som ska anropas när åtgärden är klar. done anropas med tre argument: ett felobjekt (kan vara null), ett jobbobjekt och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.

createQuery(JobType, JobStatus, number)

Skapar en fråga som kan användas för att returnera sidor med ett befintligt jobb baserat på typ och status.

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

Parametrar

jobType

JobType

Den typ som ska användas för att filtrera resultat.

jobStatus

JobStatus

Den status som ska användas för att filtrera resultat.

pageSize

number

Antalet element som ska returneras per sida.

Returer

Query

fromConnectionString(string)

Konstruerar ett JobClient-objekt från den angivna anslutningssträngen.

static function fromConnectionString(connectionString: string): JobClient

Parametrar

connectionString

string

En anslutningssträng som kapslar in lämpliga registerbehörigheter (läs- och/eller skrivbehörigheter).

Returer

JobClient

fromSharedAccessSignature(string)

Konstruerar ett JobClient-objekt från den angivna signaturen för delad åtkomst.

static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient

Parametrar

sharedAccessSignature

string

En signatur för delad åtkomst som kapslar in lämpliga (läs- och/eller skrivbehörigheter).

Returer

JobClient

fromTokenCredential(string, TokenCredential)

Konstruerar ett JobClient-objekt från den angivna delade Azure TokenCredential.

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

Parametrar

hostName

string

Värdnamnet för Azure-tjänsten.

tokenCredential
TokenCredential

En Azure TokenCredential som används för att autentisera med Azure-tjänsten

Returer

JobClient

getJob(string | number) 

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

Parametrar

jobId

string | number

Returer

Promise<JobStatusResponse>

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

Begär information om ett befintligt jobb.

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

Parametrar

jobId

string | number

Identifieraren för ett befintligt jobb.

done

TripleValueCallback<any, any>

Den valfria funktionen som ska anropas när åtgärden är klar. done anropas med tre argument: ett felobjekt (kan vara null), ett jobbobjekt och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.

scheduleDeviceMethod(string | number, string, DeviceMethodParams) 

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

Parametrar

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams

Returer

Promise<JobStatusResponse>

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

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

Parametrar

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams
jobStartTime

Date

Returer

Promise<JobStatusResponse>

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

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

Parametrar

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams
jobStartTime

Date

maxExecutionTimeInSeconds

number

Returer

Promise<JobStatusResponse>

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

Schemalägger ett jobb som ska köra en enhetsmetod på en uppsättning enheter.

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

Parametrar

jobId

string | number

Den unika identifierare som ska användas för det här jobbet.

queryCondition

string

En SQL-fråge-WHERE-sats som används för att beräkna listan över enheter som jobbet ska köras på.

methodParams
DeviceMethodParams

Ett objekt som beskriver metoden och ska ha följande egenskaper: - methodName Namnet på den metod som ska anropas. - nyttolast [valfritt] Nyttolasten som ska användas för metodanropet. - responseTimeoutInSeconds [valfritt] Antalet sekunder IoT Hub ska vänta på enheten

jobStartTime

Date

Tid då jobbet ska starta

maxExecutionTimeInSeconds

number

Den maximala tid som tilldelats för det här jobbet att köras i sekunder.

done

TripleValueCallback<any, any>

Den valfria funktionen som ska anropas när åtgärden är klar. done anropas med tre argument: ett felobjekt (kan vara null), ett jobbobjekt och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.

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

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

Parametrar

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

Parametrar

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>

Parametrar

jobId

string | number

queryCondition

string

patch

any

Returer

Promise<JobStatusResponse>

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

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

Parametrar

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

Returer

Promise<JobStatusResponse>

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

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

Parametrar

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

maxExecutionTimeInSeconds

number

Returer

Promise<JobStatusResponse>

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

Schemalägg ett jobb som uppdaterar en uppsättning tvillingar med korrigeringen som tillhandahålls som en parameter.

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

Parametrar

jobId

string | number

Den unika identifierare som ska användas för det här jobbet.

queryCondition

string

En SQL-fråge-WHERE-sats som används för att beräkna listan över enheter som jobbet ska köras på.

patch

any

Tvillingkorrigeringen som ska appliceras på tvillingarna.

jobStartTime

Date

Tid då jobbet ska starta

maxExecutionTimeInSeconds

number

Den maximala tid som tilldelats för det här jobbet att köras i sekunder.

done

TripleValueCallback<any, any>

Den valfria funktionen som ska anropas när åtgärden är klar. done anropas med tre argument: ett felobjekt (kan vara null), ett jobbobjekt och ett transportspecifikt svarsobjekt som är användbart för loggning eller felsökning.

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

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

Parametrar

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

Parametrar

jobId

string | number

queryCondition

string

patch

any

done

TripleValueCallback<any, any>