JobClient class

Пакет:

azure-iothub

Предоставляет методы для создания, обновления, мониторинга и отмены длительных заданий в экземпляре Центр Интернета вещей, а также для запроса существующих заданий. API заданий в Центр Интернета вещей Azure позволяет планировать прямые вызовы методов и обновления двойников на нескольких устройствах.

Пользователи пакета SDK должны создавать JobClient экземпляры с помощью фабричного метода fromConnectionString(string) и fromSharedAccessSignature(string).

Методы

cancelJob(string | number)
cancelJob(string | number, TripleValueCallback<any, any>)	Отменяет существующее задание.
createQuery(JobType, JobStatus, number)	Создает запрос, который можно использовать для возврата страниц существующего задания на основе типа и состояния.
fromConnectionString(string)	Создает объект JobClient из заданной строки подключения.
fromSharedAccessSignature(string)	Создает объект JobClient из заданной подписанной URL-адреса.
fromTokenCredential(string, TokenCredential)	Создает объект JobClient из заданного общего объекта Azure TokenCredential.
getJob(string | number)
getJob(string | number, TripleValueCallback<any, any>)	Запрашивает сведения о существующем задании.
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>)	Планирует задание, которое будет выполнять метод устройства на наборе устройств.
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>)	Запланируйте задание, которое обновит набор двойников с помощью исправления, предоставленного в качестве параметра.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
scheduleTwinUpdate(string | number, string, any, TripleValueCallback<any, any>)

Сведения о методе

cancelJob(string | number)

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

Параметры

jobId

string | number

Возвращаемое значение

Promise<JobStatusResponse>

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

Отменяет существующее задание.

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

Параметры

jobId

string | number

Идентификатор существующего задания.

done

TripleValueCallback<any, any>

Необязательная функция, вызываемая по завершении операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), объект задания и объект ответа, зависящий от транспорта, полезный для ведения журнала или отладки.

createQuery(JobType, JobStatus, number)

Создает запрос, который можно использовать для возврата страниц существующего задания на основе типа и состояния.

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

Параметры

jobType

JobType

Тип, который следует использовать для фильтрации результатов.

jobStatus

JobStatus

Состояние, которое следует использовать для фильтрации результатов.

pageSize

number

Количество возвращаемых элементов на страницу.

Возвращаемое значение

Query

fromConnectionString(string)

Создает объект JobClient из заданной строки подключения.

static function fromConnectionString(connectionString: string): JobClient

Параметры

connectionString

string

Строка подключения, которая инкапсулирует соответствующие разрешения реестра (чтение и запись).

Возвращаемое значение

JobClient

fromSharedAccessSignature(string)

Создает объект JobClient из заданной подписанной URL-адреса.

static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient

Параметры

sharedAccessSignature

string

Подписанный URL-адрес, который инкапсулирует соответствующие разрешения (чтение и(или) запись в реестре.

Возвращаемое значение

JobClient

fromTokenCredential(string, TokenCredential)

Создает объект JobClient из заданного общего объекта Azure TokenCredential.

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

Параметры

hostName

string

Имя узла службы Azure.

tokenCredential

TokenCredential

Azure TokenCredential, используемый для проверки подлинности в службе Azure.

Возвращаемое значение

JobClient

getJob(string | number)

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

Параметры

jobId

string | number

Возвращаемое значение

Promise<JobStatusResponse>

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

Запрашивает сведения о существующем задании.

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

Параметры

jobId

string | number

Идентификатор существующего задания.

done

TripleValueCallback<any, any>

Необязательная функция, вызываемая по завершении операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), объект задания и объект ответа, зависящий от транспорта, полезный для ведения журнала или отладки.

scheduleDeviceMethod(string | number, string, DeviceMethodParams)

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

Параметры

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

Возвращаемое значение

Promise<JobStatusResponse>

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

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

Параметры

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

jobStartTime

Date

Возвращаемое значение

Promise<JobStatusResponse>

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

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

Параметры

jobId

string | number

queryCondition

string

methodParams

DeviceMethodParams

jobStartTime

Date

maxExecutionTimeInSeconds

number

Возвращаемое значение

Promise<JobStatusResponse>

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

Планирует задание, которое будет выполнять метод устройства на наборе устройств.

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

Параметры

jobId

string | number

Уникальный идентификатор, который следует использовать для этого задания.

queryCondition

string

Предложение WHERE SQL-запроса, используемое для вычисления списка устройств, на которых должно выполняться это задание.

methodParams

DeviceMethodParams

Объект , описывающий метод и должен иметь следующие свойства: - имя_метода Имя вызываемого метода. — полезные данные [необязательно] Полезные данные, используемые для вызова метода. - responseTimeoutInSeconds [необязательно] Количество секунд, в течение которых Центр Интернета вещей должны ждать устройство.

jobStartTime

Date

Время начала задания

maxExecutionTimeInSeconds

number

Максимальное время выполнения этого задания в секундах.

done

TripleValueCallback<any, any>

Необязательная функция, вызываемая по завершении операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), объект задания и объект ответа, зависящий от транспорта, полезный для ведения журнала или отладки.

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

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

Параметры

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

Параметры

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>

Параметры

jobId

string | number

queryCondition

string

patch

any

Возвращаемое значение

Promise<JobStatusResponse>

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

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

Параметры

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

Возвращаемое значение

Promise<JobStatusResponse>

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

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

Параметры

jobId

string | number

queryCondition

string

patch

any

jobStartTime

Date

maxExecutionTimeInSeconds

number

Возвращаемое значение

Promise<JobStatusResponse>

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

Запланируйте задание, которое обновит набор двойников с помощью исправления, предоставленного в качестве параметра.

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

Параметры

jobId

string | number

Уникальный идентификатор, который следует использовать для этого задания.

queryCondition

string

Предложение WHERE SQL-запроса, используемое для вычисления списка устройств, на которых должно выполняться это задание.

patch

any

Исправление двойника, которое должно быть применено к двойникам.

jobStartTime

Date

Время начала задания

maxExecutionTimeInSeconds

number

Максимальное время выполнения этого задания в секундах.

done

TripleValueCallback<any, any>

Необязательная функция, вызываемая по завершении операции. done будет вызываться с тремя аргументами: объект Error (может иметь значение NULL), объект задания и объект ответа, зависящий от транспорта, полезный для ведения журнала или отладки.

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

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

Параметры

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

Параметры

jobId

string | number

queryCondition

string

patch

any

done

TripleValueCallback<any, any>