JobClient class

Paket:

azure-iothub

Stellt Methoden zum Erstellen, Aktualisieren, Überwachen und Abbrechen von Aufträgen mit langer Ausführung in einer IoT Hub-Instanz sowie zum Abfragen vorhandener Aufträge bereit. Die Aufträge-API in Azure IoT Hub ermöglicht das Planen direkter Methodenaufrufe und Zwillingsupdates auf mehreren Geräten.

VON SDK-Benutzern wird erwartet, dass sie Instanzen mit den Factorymethoden fromConnectionString(string) und fromSharedAccessSignature(string)erstellenJobClient.

Methoden

cancelJob(string | number)
cancelJob(string | number, TripleValueCallback<any, any>)	Bricht einen vorhandenen Auftrag ab.
createQuery(JobType, JobStatus, number)	Erstellt eine Abfrage, die verwendet werden kann, um Seiten eines vorhandenen Auftrags basierend auf Typ und Status zurückzugeben.
fromConnectionString(string)	Erstellt ein JobClient-Objekt aus der angegebenen Verbindungszeichenfolge.
fromSharedAccessSignature(string)	Erstellt ein JobClient-Objekt aus der angegebenen Shared Access Signature.
fromTokenCredential(string, TokenCredential)	Erstellt ein JobClient-Objekt aus dem angegebenen freigegebenen Azure TokenCredential.
getJob(string | number)
getJob(string | number, TripleValueCallback<any, any>)	Fordert Informationen zu einem vorhandenen Auftrag an.
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>)	Plant einen Auftrag, der eine Gerätemethode auf einer Gruppe von Geräten ausführt.
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>)	Planen Sie einen Auftrag, der eine Reihe von Zwillingen mit dem als Parameter bereitgestellten Patch aktualisiert.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>)

Details zur Methode

cancelJob(string | number)

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

Parameter

jobId

string | number

Gibt zurück

Promise<JobStatusResponse>

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

Bricht einen vorhandenen Auftrag ab.

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

Parameter

jobId

string | number

Der Bezeichner eines vorhandenen Auftrags.

done

TripleValueCallback<any, any>

Die optionale Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem Auftragsobjekt und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

createQuery(JobType, JobStatus, number)

Erstellt eine Abfrage, die verwendet werden kann, um Seiten eines vorhandenen Auftrags basierend auf Typ und Status zurückzugeben.

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

Parameter

jobType

JobType

Der Typ, der zum Filtern von Ergebnissen verwendet werden soll.

jobStatus

JobStatus

Der Status, der zum Filtern von Ergebnissen verwendet werden soll.

pageSize

number

Die Anzahl der Elemente, die pro Seite zurückgegeben werden sollen.

Gibt zurück

Query

fromConnectionString(string)

Erstellt ein JobClient-Objekt aus der angegebenen Verbindungszeichenfolge.

static function fromConnectionString(connectionString: string): JobClient

Parameter

connectionString

string

Eine Verbindungszeichenfolge, die die entsprechenden Registrierungsberechtigungen (Lese- und/oder Schreibzugriff) kapselt.

Gibt zurück

JobClient

fromSharedAccessSignature(string)

Erstellt ein JobClient-Objekt aus der angegebenen Shared Access Signature.

static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient

Parameter

sharedAccessSignature

string

Eine freigegebene Zugriffssignatur, die die entsprechenden Registrierungsberechtigungen (Lese- und/oder Schreibzugriff) kapselt.

Gibt zurück

JobClient

fromTokenCredential(string, TokenCredential)

Erstellt ein JobClient-Objekt aus dem angegebenen freigegebenen Azure TokenCredential.

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

Parameter

hostName

string

Hostname des Azure-Diensts.

tokenCredential

TokenCredential

Azure TokenCredential, die zur Authentifizierung beim Azure-Dienst verwendet werden

Gibt zurück

JobClient

getJob(string | number)

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

Parameter

jobId

string | number

Gibt zurück

Promise<JobStatusResponse>

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

Fordert Informationen zu einem vorhandenen Auftrag an.

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

Parameter

jobId

string | number

Der Bezeichner eines vorhandenen Auftrags.

done

TripleValueCallback<any, any>

Die optionale Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem Auftragsobjekt und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

scheduleDeviceMethod(string | number, string, DeviceMethodParams)

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

Parameter

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

Gibt zurück

Promise<JobStatusResponse>

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

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

Parameter

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

jobStartTime

Date

Gibt zurück

Promise<JobStatusResponse>

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

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

Parameter

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

jobStartTime

Date

maxExecutionTimeInSeconds

number

Gibt zurück

Promise<JobStatusResponse>

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

Plant einen Auftrag, der eine Gerätemethode auf einer Gruppe von Geräten ausführt.

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

Parameter

jobId

string | number

Der eindeutige Bezeichner, der für diesen Auftrag verwendet werden soll.

queryCondition

string

Eine WHERE-Klausel für die SQL-Abfrage, die zum Berechnen der Liste der Geräte verwendet wird, auf denen dieser Auftrag ausgeführt werden soll.

methodParams

DeviceMethodParams

Ein Objekt, das die Methode beschreibt und die folgenden Eigenschaften aufweisen muss: - methodName Der Name der Methode, die aufgerufen werden soll. - nutzlast [optional] Die Nutzlast, die für den Methodenaufruf verwendet werden soll. - responseTimeoutInSeconds [optional] Die Anzahl der Sekunden, IoT Hub auf das Gerät warten müssen

jobStartTime

Date

Zeitpunkt, zu dem der Auftrag gestartet werden soll

maxExecutionTimeInSeconds

number

Die maximale Zeit für die Ausführung dieses Auftrags in Sekunden.

done

TripleValueCallback<any, any>

Die optionale Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem Auftragsobjekt und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

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

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

Parameter

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

Parameter

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>

Parameter

jobId

string | number

queryCondition

string

patch

any

Gibt zurück

Promise<JobStatusResponse>

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

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

Parameter

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

Gibt zurück

Promise<JobStatusResponse>

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

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

Parameter

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

maxExecutionTimeInSeconds

number

Gibt zurück

Promise<JobStatusResponse>

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

Planen Sie einen Auftrag, der eine Reihe von Zwillingen mit dem als Parameter bereitgestellten Patch aktualisiert.

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

Parameter

jobId

string | number

Der eindeutige Bezeichner, der für diesen Auftrag verwendet werden soll.

queryCondition

string

Eine WHERE-Klausel für die SQL-Abfrage, die zum Berechnen der Liste der Geräte verwendet wird, auf denen dieser Auftrag ausgeführt werden soll.

patch

any

Der Zwillingspatch, der auf die Zwillinge angewendet werden soll.

jobStartTime

Date

Zeitpunkt, zu dem der Auftrag gestartet werden soll

maxExecutionTimeInSeconds

number

Die maximale Zeit für die Ausführung dieses Auftrags in Sekunden.

done

TripleValueCallback<any, any>

Die optionale Funktion, die nach Abschluss des Vorgangs aufgerufen werden soll. done wird mit drei Argumenten aufgerufen: einem Error-Objekt (kann NULL sein), einem Auftragsobjekt und einem transportspezifischen Antwortobjekt, das für die Protokollierung oder das Debuggen nützlich ist.

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

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

Parameter

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

Parameter

jobId

string | number

queryCondition

string

patch

any

done

TripleValueCallback<any, any>