Condividi tramite

JobClient class

  • Riferimento
Pacchetto:
azure-iothub

Fornisce metodi per creare, aggiornare, monitorare e annullare processi a esecuzione prolungata in un'istanza di hub IoT, nonché eseguire query sui processi esistenti. L'API Processi in hub IoT di Azure consente di pianificare chiamate di metodo diretto e aggiornamenti gemelli in più dispositivi.

Gli utenti dell'SDK devono creare JobClient istanze usando i metodi fromConnectionString(string) di factory e fromSharedAccessSignature(string).

Metodi

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

Annulla un processo esistente.
createQuery(JobType, JobStatus, number)

Crea una query che può essere usata per restituire pagine del processo esistente in base al tipo e allo stato.
fromConnectionString(string)

Costruisce un oggetto JobClient dalla stringa di connessione specificata.
fromSharedAccessSignature(string)

Costruisce un oggetto JobClient dalla firma di accesso condiviso specificata.
fromTokenCredential(string, TokenCredential)

Costruisce un oggetto JobClient dall'oggetto Azure TokenCredential condiviso specificato.
getJob(string | number)
getJob(string | number, TripleValueCallback<any, any>)

Richiede informazioni su un processo esistente.
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>)

Pianifica un processo che eseguirà un metodo dispositivo in un set di dispositivi.
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>)

Pianificare un processo che aggiornerà un set di gemelli con la patch fornita come parametro.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>)

Dettagli metodo

cancelJob(string | number) 

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

Parametri

jobId

string | number

Restituisce

Promise<JobStatusResponse>

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

Annulla un processo esistente.

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

Parametri

jobId

string | number

Identificatore di un processo esistente.

done

TripleValueCallback<any, any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), un oggetto processo e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

createQuery(JobType, JobStatus, number)

Crea una query che può essere usata per restituire pagine del processo esistente in base al tipo e allo stato.

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

Parametri

jobType

JobType

Tipo che deve essere usato per filtrare i risultati.

jobStatus

JobStatus

Stato che deve essere usato per filtrare i risultati.

pageSize

number

Numero di elementi da restituire per pagina.

Restituisce

Query

fromConnectionString(string)

Costruisce un oggetto JobClient dalla stringa di connessione specificata.

static function fromConnectionString(connectionString: string): JobClient

Parametri

connectionString

string

Stringa di connessione che incapsula le autorizzazioni appropriate (lettura e/o scrittura).

Restituisce

JobClient

fromSharedAccessSignature(string)

Costruisce un oggetto JobClient dalla firma di accesso condiviso specificata.

static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient

Parametri

sharedAccessSignature

string

Firma di accesso condiviso che incapsula le autorizzazioni appropriate (lettura e/o scrittura) del Registro di sistema.

Restituisce

JobClient

fromTokenCredential(string, TokenCredential)

Costruisce un oggetto JobClient dall'oggetto Azure TokenCredential condiviso specificato.

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

Parametri

hostName

string

Nome host del servizio di Azure.

tokenCredential
TokenCredential

Un token di AzureCredential usato per l'autenticazione con il servizio di Azure

Restituisce

JobClient

getJob(string | number) 

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

Parametri

jobId

string | number

Restituisce

Promise<JobStatusResponse>

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

Richiede informazioni su un processo esistente.

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

Parametri

jobId

string | number

Identificatore di un processo esistente.

done

TripleValueCallback<any, any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), un oggetto processo e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

scheduleDeviceMethod(string | number, string, DeviceMethodParams) 

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

Parametri

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams

Restituisce

Promise<JobStatusResponse>

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

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

Parametri

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams
jobStartTime

Date

Restituisce

Promise<JobStatusResponse>

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

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

Parametri

jobId

string | number

queryCondition

string

methodParams
DeviceMethodParams
jobStartTime

Date

maxExecutionTimeInSeconds

number

Restituisce

Promise<JobStatusResponse>

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

Pianifica un processo che eseguirà un metodo dispositivo in un set di dispositivi.

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

Parametri

jobId

string | number

Identificatore univoco che deve essere usato per questo processo.

queryCondition

string

Clausola WHERE query SQL usata per calcolare l'elenco di dispositivi in cui deve essere eseguito questo processo.

methodParams
DeviceMethodParams

Un oggetto che descrive il metodo e deve avere le proprietà seguenti: - methodName Il nome del metodo che deve essere richiamato. - payload [facoltativo] Payload da usare per la chiamata al metodo. - responseTimeoutInSeconds [facoltativo] Numero di secondi hub IoT deve attendere il dispositivo

jobStartTime

Date

Ora in cui il processo deve iniziare

maxExecutionTimeInSeconds

number

Tempo massimo assegnato per questo processo in secondi.

done

TripleValueCallback<any, any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), un oggetto processo e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

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

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

Parametri

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

Parametri

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>

Parametri

jobId

string | number

queryCondition

string

patch

any

Restituisce

Promise<JobStatusResponse>

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

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

Parametri

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

Restituisce

Promise<JobStatusResponse>

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

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

Parametri

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

maxExecutionTimeInSeconds

number

Restituisce

Promise<JobStatusResponse>

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

Pianificare un processo che aggiornerà un set di gemelli con la patch fornita come parametro.

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

Parametri

jobId

string | number

Identificatore univoco che deve essere usato per questo processo.

queryCondition

string

Clausola WHERE query SQL usata per calcolare l'elenco di dispositivi in cui deve essere eseguito questo processo.

patch

any

Patch gemella che deve essere applicata ai gemelli.

jobStartTime

Date

Ora in cui il processo deve iniziare

maxExecutionTimeInSeconds

number

Tempo massimo assegnato per questo processo in secondi.

done

TripleValueCallback<any, any>

Funzione facoltativa da chiamare al termine dell'operazione. done verrà chiamato con tre argomenti: un oggetto Error (può essere Null), un oggetto processo e un oggetto di risposta specifico del trasporto utile per la registrazione o il debug.

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

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

Parametri

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

Parametri

jobId

string | number

queryCondition

string

patch

any

done

TripleValueCallback<any, any>