JobClient class
IoT Hub 인스턴스에서 장기 실행 작업을 만들고, 업데이트하고, 모니터링하고, 취소하고, 기존 작업을 쿼리하는 메서드를 제공합니다. Azure IoT Hub 작업 API를 사용하면 여러 디바이스에서 직접 메서드 호출 및 쌍 업데이트를 예약할 수 있습니다.
SDK 사용자는 팩터리 메서드 fromConnectionString(string) 및 fromSharedAccessSignature(string)를 사용하여 인스턴스를 만들어야 JobClient 합니다.
메서드
메서드 세부 정보
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
적절한(읽기 및/또는 쓰기) 레지스트리 권한을 캡슐화하는 연결 문자열입니다.
반환
fromSharedAccessSignature(string)
지정된 공유 액세스 서명에서 JobClient 개체를 생성합니다.
static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient매개 변수
- sharedAccessSignature
-
string
적절한(읽기 및/또는 쓰기) 레지스트리 권한을 캡슐화하는 공유 액세스 서명입니다.
반환
fromTokenCredential(string, TokenCredential)
지정된 공유 Azure TokenCredential에서 JobClient 개체를 생성합니다.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): JobClient매개 변수
- hostName
-
string
Azure 서비스의 호스트 이름입니다.
- tokenCredential
- TokenCredential
Azure 서비스로 인증하는 데 사용되는 Azure TokenCredential
반환
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
이 작업을 실행해야 하는 디바이스 목록을 계산하는 데 사용되는 SQL 쿼리 WHERE 절입니다.
- methodParams
- DeviceMethodParams
및 메서드를 설명하는 개체에는 다음 속성이 있어야 합니다. - methodName 호출할 메서드의 이름입니다. - 페이로드 [선택 사항] 메서드 호출에 사용할 페이로드입니다. - responseTimeoutInSeconds [선택 사항] IoT Hub 디바이스를 기다리는 시간(초)입니다.
- 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
이 작업을 실행해야 하는 디바이스 목록을 계산하는 데 사용되는 SQL 쿼리 WHERE 절입니다.
- 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>