JobClient class
Fornece métodos para criar, atualizar, monitorizar e cancelar tarefas de execução prolongada numa instância de Hub IoT, bem como consultar tarefas existentes. A API de Tarefas no Hub IoT do Azure permite agendar chamadas de método direto e atualizações de duplos em vários dispositivos.
Espera-se que os utilizadores do SDK criem JobClient instâncias com os métodos fromConnectionString(string) de fábrica e fromSharedAccessSignature(string).
Métodos
Detalhes de Método
cancelJob(string | number)
function cancelJob(jobId: string | number): Promise<JobStatusResponse>Parâmetros
- jobId
-
string | number
Devoluções
Promise<JobStatusResponse>
cancelJob(string | number, TripleValueCallback<any, any>)
Cancela uma tarefa existente.
function cancelJob(jobId: string | number, done?: TripleValueCallback<any, any>)Parâmetros
- jobId
-
string | number
O identificador de uma tarefa existente.
- done
-
TripleValueCallback<any, any>
A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de Erro (pode ser nulo), um objeto de tarefa e um objeto de resposta específico do transporte útil para o registo ou a depuração.
createQuery(JobType, JobStatus, number)
Cria uma consulta que pode ser utilizada para devolver páginas de tarefas existentes com base no tipo e no estado.
function createQuery(jobType?: JobType, jobStatus?: JobStatus, pageSize?: number): QueryParâmetros
- jobType
-
JobType
O tipo que deve ser utilizado para filtrar resultados.
- jobStatus
-
JobStatus
O estado que deve ser utilizado para filtrar os resultados.
- pageSize
-
number
O número de elementos a devolver por página.
Devoluções
Query
fromConnectionString(string)
Constrói um objeto JobClient a partir da cadeia de ligação especificada.
static function fromConnectionString(connectionString: string): JobClientParâmetros
- connectionString
-
string
Uma cadeia de ligação que encapsula as permissões de Registo adequadas (leitura e/ou escrita).
Devoluções
fromSharedAccessSignature(string)
Constrói um objeto JobClient a partir da assinatura de acesso partilhado especificada.
static function fromSharedAccessSignature(sharedAccessSignature: string): JobClientParâmetros
- sharedAccessSignature
-
string
Uma assinatura de acesso partilhado que encapsula as permissões de Registo adequadas (leitura e/ou escrita).
Devoluções
fromTokenCredential(string, TokenCredential)
Constrói um objeto JobClient a partir do Azure TokenCredential partilhado especificado.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): JobClientParâmetros
- hostName
-
string
Nome do anfitrião do serviço do Azure.
- tokenCredential
- TokenCredential
Um Azure TokenCredential utilizado para autenticar com o serviço do Azure
Devoluções
getJob(string | number)
function getJob(jobId: string | number): Promise<JobStatusResponse>Parâmetros
- jobId
-
string | number
Devoluções
Promise<JobStatusResponse>
getJob(string | number, TripleValueCallback<any, any>)
Pede informações sobre uma tarefa existente.
function getJob(jobId: string | number, done?: TripleValueCallback<any, any>)Parâmetros
- jobId
-
string | number
O identificador de uma tarefa existente.
- done
-
TripleValueCallback<any, any>
A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de Erro (pode ser nulo), um objeto de tarefa e um objeto de resposta específico do transporte útil para o registo ou a depuração.
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
Devoluções
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
Devoluções
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
Devoluções
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)
Agenda uma tarefa que irá executar um método de dispositivo num 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
O identificador exclusivo que deve ser utilizado para esta tarefa.
- queryCondition
-
string
Uma cláusula WHERE de consulta SQL utilizada para calcular a lista de dispositivos nos quais esta tarefa deve ser executada.
- methodParams
- DeviceMethodParams
Um objeto que descreva o método e terá as seguintes propriedades: - methodName O nome do método que deve ser invocado. - payload [opcional] O payload a utilizar para a chamada de método. - responseTimeoutInSeconds [opcional] O número de segundos Hub IoT deve aguardar pelo dispositivo
- jobStartTime
-
Date
Hora em que a tarefa deve ser iniciada
- maxExecutionTimeInSeconds
-
number
O tempo máximo atribuído para que esta tarefa seja executada em segundos.
- done
-
TripleValueCallback<any, any>
A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de Erro (pode ser nulo), um objeto de tarefa e um objeto de resposta específico do transporte útil para o registo ou a depuração.
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
Devoluções
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
Devoluções
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
Devoluções
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number, TripleValueCallback<any, any>)
Agende uma tarefa que atualizará um conjunto de duplos com o patch fornecido como um parâmetro.
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)Parâmetros
- jobId
-
string | number
O identificador exclusivo que deve ser utilizado para esta tarefa.
- queryCondition
-
string
Uma cláusula WHERE de consulta SQL utilizada para calcular a lista de dispositivos nos quais esta tarefa deve ser executada.
- patch
-
any
O patch duplo que deve ser aplicado aos duplos.
- jobStartTime
-
Date
Hora em que a tarefa deve ser iniciada
- maxExecutionTimeInSeconds
-
number
O tempo máximo atribuído para que esta tarefa seja executada em segundos.
- done
-
TripleValueCallback<any, any>
A função opcional a chamar quando a operação estiver concluída. done será chamado com três argumentos: um objeto de Erro (pode ser nulo), um objeto de tarefa e um objeto de resposta específico do transporte útil para o registo ou a depuração.
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>