JobClient class
Fornece métodos para criar, atualizar, monitorar e cancelar trabalhos de longa execução em uma instância de Hub IoT, bem como consultar trabalhos existentes. A API de Trabalhos no Hub IoT do Azure permite agendar chamadas de método direto e atualizações de gêmeos em vários dispositivos.
Espera-se que os usuários do SDK criem JobClient instâncias usando os métodos fromConnectionString(string) de fábrica e fromSharedAccessSignature(string).
Métodos
Detalhes do método
cancelJob(string | number)
function cancelJob(jobId: string | number): Promise<JobStatusResponse>Parâmetros
- jobId
-
string | number
Retornos
Promise<JobStatusResponse>
cancelJob(string | number, TripleValueCallback<any, any>)
Cancela um trabalho existente.
function cancelJob(jobId: string | number, done?: TripleValueCallback<any, any>)Parâmetros
- jobId
-
string | number
O identificador de um trabalho existente.
- done
-
TripleValueCallback<any, any>
A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto de trabalho e um objeto de resposta específico do transporte útil para registro em log ou depuração.
createQuery(JobType, JobStatus, number)
Cria uma consulta que pode ser usada para retornar páginas do trabalho existente com base no tipo e no status.
function createQuery(jobType?: JobType, jobStatus?: JobStatus, pageSize?: number): QueryParâmetros
- jobType
-
JobType
O tipo que deve ser usado para filtrar os resultados.
- jobStatus
-
JobStatus
O status que deve ser usado para filtrar os resultados.
- pageSize
-
number
O número de elementos a serem retornados por página.
Retornos
Query
fromConnectionString(string)
Constrói um objeto JobClient da cadeia de conexão fornecida.
static function fromConnectionString(connectionString: string): JobClientParâmetros
- connectionString
-
string
Uma cadeia de conexão que encapsula as permissões apropriadas (leitura e/ou gravação) do Registro.
Retornos
fromSharedAccessSignature(string)
Constrói um objeto JobClient com base na assinatura de acesso compartilhado fornecida.
static function fromSharedAccessSignature(sharedAccessSignature: string): JobClientParâmetros
- sharedAccessSignature
-
string
Uma assinatura de acesso compartilhado que encapsula as permissões apropriadas (leitura e/ou gravação) do Registro.
Retornos
fromTokenCredential(string, TokenCredential)
Constrói um objeto JobClient do Token do Azure compartilhado fornecidoCredential.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): JobClientParâmetros
- hostName
-
string
Nome do host do serviço do Azure.
- tokenCredential
- TokenCredential
Um Token do AzureCredential usado para autenticar com o serviço do Azure
Retornos
getJob(string | number)
function getJob(jobId: string | number): Promise<JobStatusResponse>Parâmetros
- jobId
-
string | number
Retornos
Promise<JobStatusResponse>
getJob(string | number, TripleValueCallback<any, any>)
Solicita informações sobre um trabalho existente.
function getJob(jobId: string | number, done?: TripleValueCallback<any, any>)Parâmetros
- jobId
-
string | number
O identificador de um trabalho existente.
- done
-
TripleValueCallback<any, any>
A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto de trabalho e um objeto de resposta específico do transporte útil para registro em log ou 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
Retornos
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
Retornos
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
Retornos
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)
Agenda um trabalho que executará um método de dispositivo em um 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 usado para esse trabalho.
- queryCondition
-
string
Uma cláusula WHERE de consulta SQL usada para calcular a lista de dispositivos nos quais esse trabalho deve ser executado.
- methodParams
- DeviceMethodParams
Um objeto que descreve o método e deve ter as seguintes propriedades: - methodName O nome do método que deve ser invocado. – payload [opcional] O conteúdo a ser usado para a chamada de método. - responseTimeoutInSeconds [opcional] O número de segundos Hub IoT deve aguardar o dispositivo
- jobStartTime
-
Date
Hora em que o trabalho deve ser iniciado
- maxExecutionTimeInSeconds
-
number
O tempo máximo alocado para que esse trabalho seja executado em segundos.
- done
-
TripleValueCallback<any, any>
A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto de trabalho e um objeto de resposta específico do transporte útil para registro em log ou 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
Retornos
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
Retornos
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
Retornos
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number, TripleValueCallback<any, any>)
Agende um trabalho que atualizará um conjunto de gêmeos 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 usado para esse trabalho.
- queryCondition
-
string
Uma cláusula WHERE de consulta SQL usada para calcular a lista de dispositivos nos quais esse trabalho deve ser executado.
- patch
-
any
O patch gêmeo que deve ser aplicado aos gêmeos.
- jobStartTime
-
Date
Hora em que o trabalho deve ser iniciado
- maxExecutionTimeInSeconds
-
number
O tempo máximo alocado para que esse trabalho seja executado em segundos.
- done
-
TripleValueCallback<any, any>
A função opcional a ser chamada quando a operação for concluída. done será chamado com três argumentos: um objeto Error (pode ser nulo), um objeto de trabalho e um objeto de resposta específico do transporte útil para registro em log ou 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>