JobClient class
Udostępnia metody tworzenia, aktualizowania, monitorowania i anulowania długotrwałych zadań w wystąpieniu IoT Hub, a także wykonywania zapytań względem istniejących zadań. Interfejs API zadań w Azure IoT Hub umożliwia zaplanowanie wywołań metody bezpośredniej i aktualizacji bliźniaczych reprezentacji na wielu urządzeniach.
Oczekuje się, że użytkownicy zestawu SDK będą tworzyć JobClient wystąpienia przy użyciu metod fromConnectionString(string) fabrycznych i fromSharedAccessSignature(string).
Metody
Szczegóły metody
cancelJob(string | number)
function cancelJob(jobId: string | number): Promise<JobStatusResponse>Parametry
- jobId
-
string | number
Zwraca
Promise<JobStatusResponse>
cancelJob(string | number, TripleValueCallback<any, any>)
Anuluje istniejące zadanie.
function cancelJob(jobId: string | number, done?: TripleValueCallback<any, any>)Parametry
- jobId
-
string | number
Identyfikator istniejącego zadania.
- done
-
TripleValueCallback<any, any>
Opcjonalna funkcja wywoływana po zakończeniu operacji. done będzie wywoływana z trzema argumentami: obiekt Błędu (może mieć wartość null), obiekt zadania i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.
createQuery(JobType, JobStatus, number)
Tworzy zapytanie, które może służyć do zwracania stron istniejącego zadania na podstawie typu i stanu.
function createQuery(jobType?: JobType, jobStatus?: JobStatus, pageSize?: number): QueryParametry
- jobType
-
JobType
Typ, który powinien służyć do filtrowania wyników.
- jobStatus
-
JobStatus
Stan, który powinien być używany do filtrowania wyników.
- pageSize
-
number
Liczba elementów do zwrócenia na stronę.
Zwraca
Query
fromConnectionString(string)
Tworzy obiekt JobClient z podanych parametrów połączenia.
static function fromConnectionString(connectionString: string): JobClientParametry
- connectionString
-
string
Parametry połączenia, które hermetyzują odpowiednie (odczyt i/lub zapis) uprawnienia rejestru.
Zwraca
fromSharedAccessSignature(string)
Tworzy obiekt JobClient z podanego sygnatury dostępu współdzielonego.
static function fromSharedAccessSignature(sharedAccessSignature: string): JobClientParametry
- sharedAccessSignature
-
string
Sygnatura dostępu współdzielonego, która hermetyzuje odpowiednie uprawnienia rejestru (odczyt i/lub zapis).
Zwraca
fromTokenCredential(string, TokenCredential)
Tworzy obiekt JobClient z danego udostępnionego tokenu platformy AzureCredential.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): JobClientParametry
- hostName
-
string
Nazwa hosta usługi platformy Azure.
- tokenCredential
- TokenCredential
Token Platformy AzureCredential używany do uwierzytelniania w usłudze platformy Azure
Zwraca
getJob(string | number)
function getJob(jobId: string | number): Promise<JobStatusResponse>Parametry
- jobId
-
string | number
Zwraca
Promise<JobStatusResponse>
getJob(string | number, TripleValueCallback<any, any>)
Żąda informacji o istniejącym zadaniu.
function getJob(jobId: string | number, done?: TripleValueCallback<any, any>)Parametry
- jobId
-
string | number
Identyfikator istniejącego zadania.
- done
-
TripleValueCallback<any, any>
Opcjonalna funkcja wywoływana po zakończeniu operacji. done będzie wywoływana z trzema argumentami: obiekt Błędu (może mieć wartość null), obiekt zadania i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.
scheduleDeviceMethod(string | number, string, DeviceMethodParams)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams): Promise<JobStatusResponse>Parametry
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
Zwraca
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date): Promise<JobStatusResponse>Parametry
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
Zwraca
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, maxExecutionTimeInSeconds: number): Promise<JobStatusResponse>Parametry
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
- maxExecutionTimeInSeconds
-
number
Zwraca
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)
Planuje zadanie, które wykona metodę urządzenia na zestawie urządzeń.
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)Parametry
- jobId
-
string | number
Unikatowy identyfikator, który powinien być używany dla tego zadania.
- queryCondition
-
string
Klauzula WHERE zapytania SQL używana do obliczania listy urządzeń, na których ma zostać uruchomione to zadanie.
- methodParams
- DeviceMethodParams
Obiekt opisujący metodę i ma następujące właściwości: - methodName Nazwa metody, która ma zostać wywołana. - ładunek [opcjonalnie] ładunek do użycia dla wywołania metody. - responseTimeoutInSeconds [opcjonalnie] Liczba sekund IoT Hub czeka na urządzenie
- jobStartTime
-
Date
Godzina rozpoczęcia zadania
- maxExecutionTimeInSeconds
-
number
Maksymalny czas przydziału dla tego zadania do uruchomienia w sekundach.
- done
-
TripleValueCallback<any, any>
Opcjonalna funkcja wywoływana po zakończeniu operacji. done będzie wywoływana z trzema argumentami: obiekt Błędu (może mieć wartość null), obiekt zadania i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, TripleValueCallback<any, any>)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, done: TripleValueCallback<any, any>)Parametry
- 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>)Parametry
- 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>Parametry
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
Zwraca
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date): Promise<JobStatusResponse>Parametry
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
Zwraca
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, maxExecutionTimeInSeconds?: number): Promise<JobStatusResponse>Parametry
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
- maxExecutionTimeInSeconds
-
number
Zwraca
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number, TripleValueCallback<any, any>)
Zaplanuj zadanie, które zaktualizuje zestaw bliźniaczych reprezentacji z poprawką podaną jako parametr.
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)Parametry
- jobId
-
string | number
Unikatowy identyfikator, który powinien być używany dla tego zadania.
- queryCondition
-
string
Klauzula WHERE zapytania SQL używana do obliczania listy urządzeń, na których ma zostać uruchomione to zadanie.
- patch
-
any
Poprawka bliźniaczej reprezentacji, która powinna być stosowana do bliźniaczych reprezentacji.
- jobStartTime
-
Date
Godzina rozpoczęcia zadania
- maxExecutionTimeInSeconds
-
number
Maksymalny czas przydziału dla tego zadania do uruchomienia w sekundach.
- done
-
TripleValueCallback<any, any>
Opcjonalna funkcja wywoływana po zakończeniu operacji. done będzie wywoływana z trzema argumentami: obiekt Błędu (może mieć wartość null), obiekt zadania i obiekt odpowiedzi specyficzny dla transportu przydatny do rejestrowania lub debugowania.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, done: TripleValueCallback<any, any>)Parametry
- 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>)Parametry
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- done
-
TripleValueCallback<any, any>