Compartir a través de

JobClient class

  • Referencia
Paquete:
azure-iothub

Proporciona métodos para crear, actualizar, supervisar y cancelar trabajos de larga duración en una instancia de IoT Hub, así como consultar trabajos existentes. La API de trabajos de Azure IoT Hub permite programar llamadas de método directo y actualizaciones gemelas en varios dispositivos.

Se espera que los usuarios del SDK creen JobClient instancias mediante los métodos fromConnectionString(string) de fábrica y fromSharedAccessSignature(string).

Métodos

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

Cancela un trabajo existente.
createQuery(JobType, JobStatus, number)

Crea una consulta que se puede usar para devolver páginas de trabajo existentes en función del tipo y el estado.
fromConnectionString(string)

Construye un objeto JobClient a partir de la cadena de conexión especificada.
fromSharedAccessSignature(string)

Construye un objeto JobClient a partir de la firma de acceso compartido especificada.
fromTokenCredential(string, TokenCredential)

Construye un objeto JobClient a partir del token de Azure TokenCredential compartido especificado.
getJob(string | number)
getJob(string | number, TripleValueCallback<any, any>)

Solicita información sobre un trabajo existente.
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>)

Programa un trabajo que ejecutará un método de dispositivo en un conjunto de dispositivos.
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>)

Programe un trabajo que actualizará un conjunto de gemelos con la revisión proporcionada como parámetro.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>)

Detalles del método

cancelJob(string | number) 

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

Parámetros

jobId

string | number

Devoluciones

Promise<JobStatusResponse>

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

Cancela un trabajo existente.

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

Parámetros

jobId

string | number

Identificador de un trabajo existente.

done

TripleValueCallback<any, any>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser NULL), un objeto de trabajo y un objeto de respuesta específico del transporte útil para registrar o depurar.

createQuery(JobType, JobStatus, number)

Crea una consulta que se puede usar para devolver páginas de trabajo existentes en función del tipo y el estado.

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

Parámetros

jobType

JobType

Tipo que se debe usar para filtrar los resultados.

jobStatus

JobStatus

Estado que se debe usar para filtrar los resultados.

pageSize

number

Número de elementos que se van a devolver por página.

Devoluciones

Query

fromConnectionString(string)

Construye un objeto JobClient a partir de la cadena de conexión especificada.

static function fromConnectionString(connectionString: string): JobClient

Parámetros

connectionString

string

Cadena de conexión que encapsula los permisos del Registro de lectura o escritura adecuados.

Devoluciones

JobClient

fromSharedAccessSignature(string)

Construye un objeto JobClient a partir de la firma de acceso compartido especificada.

static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient

Parámetros

sharedAccessSignature

string

Firma de acceso compartido que encapsula los permisos del Registro de lectura o escritura adecuados.

Devoluciones

JobClient

fromTokenCredential(string, TokenCredential)

Construye un objeto JobClient a partir del token de Azure TokenCredential compartido especificado.

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

Parámetros

hostName

string

Nombre de host del servicio de Azure.

tokenCredential
TokenCredential

Un TokenCredential de Azure que se usa para autenticarse con el servicio de Azure

Devoluciones

JobClient

getJob(string | number) 

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

Parámetros

jobId

string | number

Devoluciones

Promise<JobStatusResponse>

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

Solicita información sobre un trabajo existente.

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

Parámetros

jobId

string | number

Identificador de un trabajo existente.

done

TripleValueCallback<any, any>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser NULL), un objeto de trabajo y un objeto de respuesta específico del transporte útil para registrar o depurar.

scheduleDeviceMethod(string | number, string, DeviceMethodParams) 

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

Parámetros

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams

Devoluciones

Promise<JobStatusResponse>

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

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

Parámetros

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams
jobStartTime

Date

Devoluciones

Promise<JobStatusResponse>

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

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

Parámetros

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams
jobStartTime

Date

maxExecutionTimeInSeconds

number

Devoluciones

Promise<JobStatusResponse>

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

Programa un trabajo que ejecutará un método de dispositivo en un conjunto de dispositivos.

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

Parámetros

jobId

string | number

Identificador único que se debe usar para este trabajo.

queryCondition

string

Una cláusula WHERE de consulta SQL usada para calcular la lista de dispositivos en los que se debe ejecutar este trabajo.

methodParams
DeviceMethodParams

Un objeto que describe el método y debe tener las siguientes propiedades: - methodName El nombre del método que se invocará. - carga [opcional] Carga útil que se va a usar para la llamada al método. - responseTimeoutInSeconds [opcional] El número de segundos IoT Hub esperará el dispositivo.

jobStartTime

Date

Hora en la que se debe iniciar el trabajo

maxExecutionTimeInSeconds

number

Tiempo máximo asignado para que este trabajo se ejecute en segundos.

done

TripleValueCallback<any, any>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser NULL), un objeto de trabajo y un objeto de respuesta específico del transporte útil para registrar o depurar.

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

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

Parámetros

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

Parámetros

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>

Parámetros

jobId

string | number

queryCondition

string

patch

any

Devoluciones

Promise<JobStatusResponse>

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

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

Parámetros

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

Devoluciones

Promise<JobStatusResponse>

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

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

Parámetros

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

maxExecutionTimeInSeconds

number

Devoluciones

Promise<JobStatusResponse>

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

Programe un trabajo que actualizará un conjunto de gemelos con la revisión proporcionada como parámetro.

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

Parámetros

jobId

string | number

Identificador único que se debe usar para este trabajo.

queryCondition

string

Una cláusula WHERE de consulta SQL usada para calcular la lista de dispositivos en los que se debe ejecutar este trabajo.

patch

any

Revisión de gemelos que se debe aplicar a los gemelos.

jobStartTime

Date

Hora en la que se debe iniciar el trabajo

maxExecutionTimeInSeconds

number

Tiempo máximo asignado para que este trabajo se ejecute en segundos.

done

TripleValueCallback<any, any>

Función opcional a la que se llamará cuando se complete la operación. done se llamará con tres argumentos: un objeto Error (puede ser NULL), un objeto de trabajo y un objeto de respuesta específico del transporte útil para registrar o depurar.

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

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

Parámetros

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

Parámetros

jobId

string | number

queryCondition

string

patch

any

done

TripleValueCallback<any, any>