JobClient class
Biedt methoden voor het maken, bijwerken, bewaken en annuleren van langlopende taken op een IoT Hub-exemplaar, evenals het uitvoeren van query's op bestaande taken. Met de Taken-API in Azure IoT Hub kunt u directe methode-aanroepen en dubbele updates plannen op meerdere apparaten.
SDK-gebruikers maken naar verwachting JobClient exemplaren met behulp van de factory-methoden fromConnectionString(string) en fromSharedAccessSignature(string).
Methoden
Methodedetails
cancelJob(string | number)
function cancelJob(jobId: string | number): Promise<JobStatusResponse>Parameters
- jobId
-
string | number
Retouren
Promise<JobStatusResponse>
cancelJob(string | number, TripleValueCallback<any, any>)
Hiermee annuleert u een bestaande taak.
function cancelJob(jobId: string | number, done?: TripleValueCallback<any, any>)Parameters
- jobId
-
string | number
De id van een bestaande taak.
- done
-
TripleValueCallback<any, any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid.
done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een taakobject en een transportspecifiek antwoordobject dat nuttig is voor logboekregistratie of foutopsporing.
createQuery(JobType, JobStatus, number)
Hiermee maakt u een query die kan worden gebruikt om pagina's van bestaande taken te retourneren op basis van het type en de status.
function createQuery(jobType?: JobType, jobStatus?: JobStatus, pageSize?: number): QueryParameters
- jobType
-
JobType
Het type dat moet worden gebruikt om resultaten te filteren.
- jobStatus
-
JobStatus
De status die moet worden gebruikt om resultaten te filteren.
- pageSize
-
number
Het aantal elementen dat per pagina moet worden geretourneerd.
Retouren
Query
fromConnectionString(string)
Hiermee maakt u een JobClient-object op basis van de opgegeven verbindingsreeks.
static function fromConnectionString(connectionString: string): JobClientParameters
- connectionString
-
string
Een verbindingsreeks die de juiste registermachtigingen (lezen en/of schrijven) inkapselt.
Retouren
fromSharedAccessSignature(string)
Hiermee wordt een JobClient-object samengesteld op basis van de opgegeven handtekening voor gedeelde toegang.
static function fromSharedAccessSignature(sharedAccessSignature: string): JobClientParameters
- sharedAccessSignature
-
string
Een handtekening voor gedeelde toegang die de juiste registermachtigingen (lezen en/of schrijven) inkapselt.
Retouren
fromTokenCredential(string, TokenCredential)
Hiermee wordt een JobClient-object samengesteld op basis van het opgegeven gedeelde Azure TokenCredential.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): JobClientParameters
- hostName
-
string
Hostnaam van de Azure-service.
- tokenCredential
- TokenCredential
Een Azure TokenCredential die wordt gebruikt om te verifiëren met de Azure-service
Retouren
getJob(string | number)
function getJob(jobId: string | number): Promise<JobStatusResponse>Parameters
- jobId
-
string | number
Retouren
Promise<JobStatusResponse>
getJob(string | number, TripleValueCallback<any, any>)
Vraagt informatie over een bestaande taak aan.
function getJob(jobId: string | number, done?: TripleValueCallback<any, any>)Parameters
- jobId
-
string | number
De id van een bestaande taak.
- done
-
TripleValueCallback<any, any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid.
done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een taakobject en een transportspecifiek antwoordobject dat nuttig is voor logboekregistratie of foutopsporing.
scheduleDeviceMethod(string | number, string, DeviceMethodParams)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams): Promise<JobStatusResponse>Parameters
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
Retouren
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date): Promise<JobStatusResponse>Parameters
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
Retouren
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, maxExecutionTimeInSeconds: number): Promise<JobStatusResponse>Parameters
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
- maxExecutionTimeInSeconds
-
number
Retouren
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)
Hiermee plant u een taak waarmee een apparaatmethode wordt uitgevoerd op een set apparaten.
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)Parameters
- jobId
-
string | number
De unieke id die moet worden gebruikt voor deze taak.
- queryCondition
-
string
Een SQL-query-WHERE-component die wordt gebruikt voor het berekenen van de lijst met apparaten waarop deze taak moet worden uitgevoerd.
- methodParams
- DeviceMethodParams
Een object dat de methode beschrijft en de volgende eigenschappen heeft: - methodName De naam van de methode die moet worden aangeroepen. - payload [optioneel] De nettolading die moet worden gebruikt voor de methode-aanroep. - responseTimeoutInSeconds [optioneel] Het aantal seconden dat IoT Hub wacht op het apparaat
- jobStartTime
-
Date
Tijdstip waarop de taak moet worden gestart
- maxExecutionTimeInSeconds
-
number
De maximale tijd die is toegewezen voor deze taak om in seconden te worden uitgevoerd.
- done
-
TripleValueCallback<any, any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid.
done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een taakobject en een transportspecifiek antwoordobject dat nuttig is voor logboekregistratie of foutopsporing.
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, TripleValueCallback<any, any>)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, done: TripleValueCallback<any, any>)Parameters
- 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>)Parameters
- 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>Parameters
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
Retouren
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date): Promise<JobStatusResponse>Parameters
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
Retouren
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, maxExecutionTimeInSeconds?: number): Promise<JobStatusResponse>Parameters
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
- maxExecutionTimeInSeconds
-
number
Retouren
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number, TripleValueCallback<any, any>)
Plan een taak die een set tweelingen bijwerkt met de patch die als parameter is opgegeven.
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)Parameters
- jobId
-
string | number
De unieke id die moet worden gebruikt voor deze taak.
- queryCondition
-
string
Een SQL-query-WHERE-component die wordt gebruikt voor het berekenen van de lijst met apparaten waarop deze taak moet worden uitgevoerd.
- patch
-
any
De dubbelpatch die moet worden toegepast op de tweelingen.
- jobStartTime
-
Date
Tijdstip waarop de taak moet worden gestart
- maxExecutionTimeInSeconds
-
number
De maximale tijd die is toegewezen voor deze taak om in seconden te worden uitgevoerd.
- done
-
TripleValueCallback<any, any>
De optionele functie die moet worden aangeroepen wanneer de bewerking is voltooid.
done wordt aangeroepen met drie argumenten: een foutobject (kan null zijn), een taakobject en een transportspecifiek antwoordobject dat nuttig is voor logboekregistratie of foutopsporing.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, done: TripleValueCallback<any, any>)Parameters
- 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>)Parameters
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- done
-
TripleValueCallback<any, any>