JobClient class
Fournit des méthodes pour créer, mettre à jour, surveiller et annuler des travaux de longue durée sur une instance de IoT Hub, ainsi que pour interroger des travaux existants. L’API Travaux dans Azure IoT Hub permet de planifier des appels de méthode directe et des mises à jour de jumeau sur plusieurs appareils.
Les utilisateurs du KIT de développement logiciel (SDK) doivent créer JobClient des instances à l’aide des méthodes fromConnectionString(string) de fabrique et fromSharedAccessSignature(string).
Méthodes
Détails de la méthode
cancelJob(string | number)
function cancelJob(jobId: string | number): Promise<JobStatusResponse>Paramètres
- jobId
-
string | number
Retours
Promise<JobStatusResponse>
cancelJob(string | number, TripleValueCallback<any, any>)
Annule un travail existant.
function cancelJob(jobId: string | number, done?: TripleValueCallback<any, any>)Paramètres
- jobId
-
string | number
Identificateur d’un travail existant.
- done
-
TripleValueCallback<any, any>
Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un objet de travail et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.
createQuery(JobType, JobStatus, number)
Crée une requête qui peut être utilisée pour retourner des pages de travail existant en fonction du type et de l’état.
function createQuery(jobType?: JobType, jobStatus?: JobStatus, pageSize?: number): QueryParamètres
- jobType
-
JobType
Type qui doit être utilisé pour filtrer les résultats.
- jobStatus
-
JobStatus
État à utiliser pour filtrer les résultats.
- pageSize
-
number
Nombre d’éléments à retourner par page.
Retours
Query
fromConnectionString(string)
Construit un objet JobClient à partir de la chaîne de connexion donnée.
static function fromConnectionString(connectionString: string): JobClientParamètres
- connectionString
-
string
Chaîne de connexion qui encapsule les autorisations de Registre appropriées (lecture et/ou écriture).
Retours
fromSharedAccessSignature(string)
Construit un objet JobClient à partir de la signature d’accès partagé donnée.
static function fromSharedAccessSignature(sharedAccessSignature: string): JobClientParamètres
- sharedAccessSignature
-
string
Signature d’accès partagé qui encapsule les autorisations de Registre appropriées (lecture et/ou écriture).
Retours
fromTokenCredential(string, TokenCredential)
Construit un objet JobClient à partir du jeton Azure TokenCredential partagé donné.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): JobClientParamètres
- hostName
-
string
Nom d’hôte du service Azure.
- tokenCredential
- TokenCredential
Un jeton Azure TokenCredential utilisé pour s’authentifier auprès du service Azure
Retours
getJob(string | number)
function getJob(jobId: string | number): Promise<JobStatusResponse>Paramètres
- jobId
-
string | number
Retours
Promise<JobStatusResponse>
getJob(string | number, TripleValueCallback<any, any>)
Demande des informations sur un travail existant.
function getJob(jobId: string | number, done?: TripleValueCallback<any, any>)Paramètres
- jobId
-
string | number
Identificateur d’un travail existant.
- done
-
TripleValueCallback<any, any>
Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un objet de travail et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.
scheduleDeviceMethod(string | number, string, DeviceMethodParams)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams): Promise<JobStatusResponse>Paramètres
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
Retours
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date): Promise<JobStatusResponse>Paramètres
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
Retours
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ètres
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
- maxExecutionTimeInSeconds
-
number
Retours
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)
Planifie un travail qui exécutera une méthode d’appareil sur un ensemble d’appareils.
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)Paramètres
- jobId
-
string | number
Identificateur unique qui doit être utilisé pour ce travail.
- queryCondition
-
string
Clause WHERE de requête SQL utilisée pour calculer la liste des appareils sur lesquels ce travail doit être exécuté.
- methodParams
- DeviceMethodParams
Objet décrivant la méthode et doit avoir les propriétés suivantes : - methodName Nom de la méthode à appeler. - charge utile [facultative] Charge utile à utiliser pour l’appel de méthode. - responseTimeoutInSeconds [facultatif] Le nombre de secondes IoT Hub doit attendre l’appareil
- jobStartTime
-
Date
Heure à laquelle le travail doit démarrer
- maxExecutionTimeInSeconds
-
number
Durée maximale d’exécution de ce travail en secondes.
- done
-
TripleValueCallback<any, any>
Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un objet de travail et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.
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ètres
- 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ètres
- 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ètres
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
Retours
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date): Promise<JobStatusResponse>Paramètres
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
Retours
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ètres
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
- maxExecutionTimeInSeconds
-
number
Retours
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number, TripleValueCallback<any, any>)
Planifiez un travail qui met à jour un ensemble de jumeaux avec le correctif fourni en tant que paramètre.
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)Paramètres
- jobId
-
string | number
Identificateur unique qui doit être utilisé pour ce travail.
- queryCondition
-
string
Clause WHERE de requête SQL utilisée pour calculer la liste des appareils sur lesquels ce travail doit être exécuté.
- patch
-
any
Correctif de jumeau qui doit être appliqué aux jumeaux.
- jobStartTime
-
Date
Heure à laquelle le travail doit démarrer
- maxExecutionTimeInSeconds
-
number
Durée maximale d’exécution de ce travail en secondes.
- done
-
TripleValueCallback<any, any>
Fonction facultative à appeler lorsque l’opération est terminée. done sera appelé avec trois arguments : un objet Error (peut être null), un objet de travail et un objet de réponse spécifique au transport utile pour la journalisation ou le débogage.
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ètres
- 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ètres
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- done
-
TripleValueCallback<any, any>