JobClient class

‏‏المرجع

الحزمة:: azure-iothub

يوفر أساليب لإنشاء وتحديث ومراقبة وإلغاء المهام طويلة الأمد على مثيل IoT Hub، بالإضافة إلى الاستعلام عن الوظائف الموجودة. تسمح واجهة برمجة تطبيقات الوظائف في Azure IoT Hub بجدولة استدعاءات الأسلوب المباشر والتحديثات المزدوجة على أجهزة متعددة.

من المتوقع أن يقوم مستخدمو 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 من توقيع الوصول المشترك المحدد.
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 بثلاث وسيطات: كائن خطأ (يمكن أن يكون خاليا)، وعنصر مهمة، وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.

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 من توقيع الوصول المشترك المحدد.

static function fromSharedAccessSignature(sharedAccessSignature: string): JobClient

المعلمات

sharedAccessSignature: string

توقيع وصول مشترك يغلف أذونات التسجيل المناسبة (للقراءة و/أو الكتابة).

المرتجعات

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>

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>

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>

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>

مشاركة عبر

JobClient class

الأساليب

تفاصيل الأسلوب

cancelJob(string | number)

المعلمات

المرتجعات

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

المعلمات

createQuery(JobType, JobStatus, number)

المعلمات

المرتجعات

fromConnectionString(string)

المعلمات

المرتجعات

fromSharedAccessSignature(string)

المعلمات

المرتجعات

fromTokenCredential(string, 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>)

المعلمات

الموارد الإضافية