JobClient class
IoT Hub örneğinde uzun süre çalışan işleri oluşturma, güncelleştirme, izleme ve iptal etme yöntemlerinin yanı sıra mevcut işleri sorgulamaya yönelik yöntemler sağlar. Azure IoT Hub'daki İşler API'si, birden çok cihazda doğrudan yöntem çağrıları ve ikiz güncelleştirmeleri zamanlamanıza olanak tanır.
SDK kullanıcılarının fromConnectionString(string) ve fromSharedAccessSignature(string)fabrika yöntemlerini kullanarak JobClient örnekleri oluşturması beklenir.
Yöntemler
Yöntem Ayrıntıları
cancelJob(string | number)
function cancelJob(jobId: string | number): Promise<JobStatusResponse>
Parametreler
- jobId
-
string | number
Döndürülenler
Promise<JobStatusResponse>
cancelJob(string | number, TripleValueCallback<any, any>)
Var olan bir işi iptal eder.
function cancelJob(jobId: string | number, done?: TripleValueCallback<any, any>)
Parametreler
- jobId
-
string | number
Var olan bir işin tanımlayıcısı.
- done
-
TripleValueCallback<any, any>
İşlem tamamlandığında çağrılacak isteğe bağlı işlev.
done
üç bağımsız değişkenle çağrılır: Hata nesnesi (null olabilir), bir iş nesnesi ve günlüğe kaydetme veya hata ayıklama için yararlı olan aktarıma özgü yanıt nesnesi.
createQuery(JobType, JobStatus, number)
Türüne ve durumuna göre var olan işin sayfalarını döndürmek için kullanılabilecek bir sorgu oluşturur.
function createQuery(jobType?: JobType, jobStatus?: JobStatus, pageSize?: number): Query
Parametreler
- jobType
-
JobType
Sonuçları filtrelemek için kullanılması gereken tür.
- jobStatus
-
JobStatus
Sonuçları filtrelemek için kullanılması gereken durum.
- pageSize
-
number
Sayfa başına döndürülecek öğe sayısı.
Döndürülenler
Query
fromConnectionString(string)
Verilen bağlantı dizesinden bir JobClient nesnesi oluşturur.
static function fromConnectionString(connectionString: string): JobClient
Parametreler
- connectionString
-
string
Uygun (okuma ve/veya yazma) Kayıt Defteri izinlerini kapsülleyen bir bağlantı dizesi.
Döndürülenler
fromSharedAccessSignature(string)
Verilen paylaşılan erişim imzasından bir JobClient nesnesi oluşturur.
static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient
Parametreler
- sharedAccessSignature
-
string
Uygun (okuma ve/veya yazma) Kayıt Defteri izinlerini kapsülleyen paylaşılan erişim imzası.
Döndürülenler
fromTokenCredential(string, TokenCredential)
Verilen paylaşılan Azure TokenCredential öğesinden bir JobClient nesnesi oluşturur.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential): JobClient
Parametreler
- hostName
-
string
Azure hizmetinin ana bilgisayar adı.
- tokenCredential
- TokenCredential
Azure hizmetiyle kimlik doğrulaması yapmak için kullanılan Azure TokenCredential
Döndürülenler
getJob(string | number)
function getJob(jobId: string | number): Promise<JobStatusResponse>
Parametreler
- jobId
-
string | number
Döndürülenler
Promise<JobStatusResponse>
getJob(string | number, TripleValueCallback<any, any>)
Mevcut bir iş hakkında bilgi istemektedir.
function getJob(jobId: string | number, done?: TripleValueCallback<any, any>)
Parametreler
- jobId
-
string | number
Var olan bir işin tanımlayıcısı.
- done
-
TripleValueCallback<any, any>
İşlem tamamlandığında çağrılacak isteğe bağlı işlev.
done
üç bağımsız değişkenle çağrılır: Hata nesnesi (null olabilir), bir iş nesnesi ve günlüğe kaydetme veya hata ayıklama için yararlı olan aktarıma özgü yanıt nesnesi.
scheduleDeviceMethod(string | number, string, DeviceMethodParams)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams): Promise<JobStatusResponse>
Parametreler
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
Döndürülenler
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date): Promise<JobStatusResponse>
Parametreler
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
Döndürülenler
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, maxExecutionTimeInSeconds: number): Promise<JobStatusResponse>
Parametreler
- jobId
-
string | number
- queryCondition
-
string
- methodParams
- DeviceMethodParams
- jobStartTime
-
Date
- maxExecutionTimeInSeconds
-
number
Döndürülenler
Promise<JobStatusResponse>
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, number, TripleValueCallback<any, any>)
Bir cihaz kümesinde cihaz yöntemi yürütecek bir iş zamanlar.
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)
Parametreler
- jobId
-
string | number
Bu iş için kullanılması gereken benzersiz tanımlayıcı.
- queryCondition
-
string
Bu işin çalıştırılması gereken cihazların listesini hesaplamak için kullanılan BIR SQL sorgusu WHERE yan tümcesi.
- methodParams
- DeviceMethodParams
yöntemini açıklayan bir nesne ve şu özelliklere sahip olacaktır: - methodName Çağrılacak yöntemin adı. - payload [isteğe bağlı] Yöntem çağrısı için kullanılacak yük. - responseTimeoutInSeconds [isteğe bağlı] IoT Hub'ın cihaz için bekleyeceği saniye sayısı
- jobStartTime
-
Date
İşin başlaması gereken zaman
- maxExecutionTimeInSeconds
-
number
Bu işin saniye cinsinden çalışması için ayrılan en uzun süre.
- done
-
TripleValueCallback<any, any>
İşlem tamamlandığında çağrılacak isteğe bağlı işlev.
done
üç bağımsız değişkenle çağrılır: Hata nesnesi (null olabilir), bir iş nesnesi ve günlüğe kaydetme veya hata ayıklama için yararlı olan aktarıma özgü yanıt nesnesi.
scheduleDeviceMethod(string | number, string, DeviceMethodParams, Date, TripleValueCallback<any, any>)
function scheduleDeviceMethod(jobId: string | number, queryCondition: string, methodParams: DeviceMethodParams, jobStartTime: Date, done: TripleValueCallback<any, any>)
Parametreler
- 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>)
Parametreler
- 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>
Parametreler
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
Döndürülenler
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date): Promise<JobStatusResponse>
Parametreler
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
Döndürülenler
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, maxExecutionTimeInSeconds?: number): Promise<JobStatusResponse>
Parametreler
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- jobStartTime
-
Date
- maxExecutionTimeInSeconds
-
number
Döndürülenler
Promise<JobStatusResponse>
scheduleTwinUpdate(string | number, string, any, Date, number, TripleValueCallback<any, any>)
Bir ikiz kümesini parametre olarak sağlanan düzeltme eki ile güncelleştirecek bir iş zamanlayın.
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime?: Date, maxExecutionTimeInSeconds?: number, done?: TripleValueCallback<any, any>)
Parametreler
- jobId
-
string | number
Bu iş için kullanılması gereken benzersiz tanımlayıcı.
- queryCondition
-
string
Bu işin çalıştırılması gereken cihazların listesini hesaplamak için kullanılan BIR SQL sorgusu WHERE yan tümcesi.
- patch
-
any
İkizlere uygulanması gereken ikiz yaması.
- jobStartTime
-
Date
İşin başlaması gereken zaman
- maxExecutionTimeInSeconds
-
number
Bu işin saniye cinsinden çalışması için ayrılan en uzun süre.
- done
-
TripleValueCallback<any, any>
İşlem tamamlandığında çağrılacak isteğe bağlı işlev.
done
üç bağımsız değişkenle çağrılır: Hata nesnesi (null olabilir), bir iş nesnesi ve günlüğe kaydetme veya hata ayıklama için yararlı olan aktarıma özgü yanıt nesnesi.
scheduleTwinUpdate(string | number, string, any, Date, TripleValueCallback<any, any>)
function scheduleTwinUpdate(jobId: string | number, queryCondition: string, patch: any, jobStartTime: Date, done: TripleValueCallback<any, any>)
Parametreler
- 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>)
Parametreler
- jobId
-
string | number
- queryCondition
-
string
- patch
-
any
- done
-
TripleValueCallback<any, any>