DurableClient class

الحزمة:

durable-functions

عميل لبدء الاستعلام عن الأحداث وإنهائها ورفعها إلى مثيلات التنسيق والكيان.

الخصائص

taskHubName

اسم مركز المهام الذي تم تكوينه على مثيل عميل التنسيق هذا.

الأساليب

createCheckStatusResponse(undefined | HttpRequest, string)	إنشاء استجابة HTTP مفيدة للتحقق من حالة المثيل المحدد.
createHttpManagementPayload(string)	إنشاء كائن HttpManagementPayload يحتوي على نقاط نهاية HTTP لإدارة المثيل.
getStatus(string, GetStatusOptions)	يحصل على حالة مثيل التنسيق المحدد.
getStatusAll()	يحصل على حالة جميع مثيلات التنسيق.
getStatusBy(OrchestrationFilter)	يحصل على حالة جميع مثيلات التنسيق التي تطابق الشروط المحددة.
purgeInstanceHistory(string)	إزالة المحفوظات لمثيل تزامن معين.
purgeInstanceHistoryBy(OrchestrationFilter)	قم بإزالة محفوظات التزامن للمثيلات التي تطابق الشروط.
raiseEvent(string, string, unknown, TaskHubOptions)	إرسال رسالة إعلام حدث إلى مثيل تنسيق انتظار.
readEntityState<T>(EntityId, TaskHubOptions)	يحاول قراءة الحالة الحالية للكيان. إرجاع غير معرف إذا كان الكيان غير موجود، أو إذا كانت الحالة المتسلسلة JSON للكيان أكبر من 16 كيلوبايت.
rewind(string, string, TaskHubOptions)	إرجاع مثيل التنسيق الفاشل المحدد لسبب ما.
signalEntity(EntityId, string, unknown, TaskHubOptions)	يشير إلى كيان لتنفيذ عملية.
startNew(string, StartNewOptions)	بدء مثيل جديد لدالة المنسق المحددة. إذا كان مثيل تزامن بالمعرف المحدد موجودا بالفعل، استبدال المثيل الموجود بصمت بهذا المثيل الجديد.
terminate(string, string)	إنهاء مثيل تزامن قيد التشغيل.
waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)	إنشاء استجابة HTTP التي تحتوي إما على حمولة من عناوين URL للإدارة لمثيل غير مكتمل أو تحتوي على الحمولة التي تحتوي على إخراج التنسيق المكتمل. إذا لم يكتمل التنسيق خلال المهلة المحددة، فستكون استجابة HTTP مطابقة لاستجابة createCheckStatusResponse().

تفاصيل الخاصية

taskHubName

اسم مركز المهام الذي تم تكوينه على مثيل عميل التنسيق هذا.

taskHubName: string

قيمة الخاصية

string

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

createCheckStatusResponse(undefined | HttpRequest, string)

إنشاء استجابة HTTP مفيدة للتحقق من حالة المثيل المحدد.

function createCheckStatusResponse(request: undefined | HttpRequest, instanceId: string): HttpResponse

المعلمات

request

undefined | HttpRequest

طلب HTTP الذي قام بتشغيل مثيل التنسيق الحالي.

instanceId

string

معرف مثيل التزامن المراد التحقق منها.

المرتجعات

HttpResponse

استجابة HTTP 202 مع عنوان الموقع وحمولة تحتوي على عناوين URL لإدارة المثيل.

createHttpManagementPayload(string)

إنشاء كائن HttpManagementPayload يحتوي على نقاط نهاية HTTP لإدارة المثيل.

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

المعلمات

instanceId

string

معرف مثيل التزامن المراد التحقق منها.

المرتجعات

HttpManagementPayload

getStatus(string, GetStatusOptions)

يحصل على حالة مثيل التنسيق المحدد.

function getStatus(instanceId: string, options?: GetStatusOptions): Promise<DurableOrchestrationStatus>

المعلمات

instanceId

string

معرف مثيل التنسيق للاستعلام.

options

GetStatusOptions

عنصر خيارات يحدد تكوينا إضافيا

المرتجعات

Promise<DurableOrchestrationStatus>

getStatusAll()

يحصل على حالة جميع مثيلات التنسيق.

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

المرتجعات

Promise<DurableOrchestrationStatus[]>

getStatusBy(OrchestrationFilter)

يحصل على حالة جميع مثيلات التنسيق التي تطابق الشروط المحددة.

function getStatusBy(filter: OrchestrationFilter): Promise<DurableOrchestrationStatus[]>

المعلمات

filter

OrchestrationFilter

كائن OrchestrationFilter الذي يحدد التنسيقات المراد استردادها.

المرتجعات

Promise<DurableOrchestrationStatus[]>

purgeInstanceHistory(string)

إزالة المحفوظات لمثيل تزامن معين.

function purgeInstanceHistory(instanceId: string): Promise<PurgeHistoryResult>

المعلمات

instanceId

string

معرف مثيل التنسيق المراد إزالته.

المرتجعات

Promise<PurgeHistoryResult>

purgeInstanceHistoryBy(OrchestrationFilter)

قم بإزالة محفوظات التزامن للمثيلات التي تطابق الشروط.

function purgeInstanceHistoryBy(filter: OrchestrationFilter): Promise<PurgeHistoryResult>

المعلمات

filter

OrchestrationFilter

كائن OrchestrationFilter الذي يحدد التنسيقات التي يجب إزالتها.

المرتجعات

Promise<PurgeHistoryResult>

raiseEvent(string, string, unknown, TaskHubOptions)

إرسال رسالة إعلام حدث إلى مثيل تنسيق انتظار.

function raiseEvent(instanceId: string, eventName: string, eventData: unknown, options?: TaskHubOptions): Promise<void>

المعلمات

instanceId

string

معرف مثيل التنسيق الذي سيتعامل مع الحدث.

eventName

string

اسم الحدث.

eventData

unknown

البيانات القابلة للتسلسل JSON المقترنة بالحدث.

options

TaskHubOptions

كائن يوفر TaskHubName لمثيل التنسيق واسم سلسلة الاتصال المقترنة به

المرتجعات

Promise<void>

وعد يتم حله عند تحديد رسالة إعلام الحدث في قائمة الانتظار.

لمعالجة الحدث، يجب أن ينتظر مثيل التنسيق الهدف حدثا يسمى eventName باستخدام waitForExternalEvent(string).

إذا لم يتم العثور على المثيل المحدد أو لم يتم تشغيله، فلن يكون لهذه العملية أي تأثير.

readEntityState<T>(EntityId, TaskHubOptions)

يحاول قراءة الحالة الحالية للكيان. إرجاع غير معرف إذا كان الكيان غير موجود، أو إذا كانت الحالة المتسلسلة JSON للكيان أكبر من 16 كيلوبايت.

function readEntityState<T>(entityId: EntityId, options?: TaskHubOptions): Promise<EntityStateResponse<T>>

المعلمات

entityId

EntityId

الكيان الهدف.

options

TaskHubOptions

عنصر اختياري يوفر TaskHubName للكيان الهدف واسم سلسلة الاتصال المقترنة به

المرتجعات

Promise<EntityStateResponse<T>>

استجابة تحتوي على الحالة الحالية للكيان.

rewind(string, string, TaskHubOptions)

إرجاع مثيل التنسيق الفاشل المحدد لسبب ما.

function rewind(instanceId: string, reason: string, options?: TaskHubOptions): Promise<void>

المعلمات

instanceId

string

معرف مثيل التنسيق لإرجاعه.

reason

string

سبب إرجاع مثيل التنسيق.

options

TaskHubOptions

كائن يوفر TaskHubName لمثيل التنسيق واسم سلسلة الاتصال المقترنة به

المرتجعات

Promise<void>

وعد يتم حله عند ترتيب رسالة الإرجاع في قائمة الانتظار.

هذه الميزة قيد المعاينة حاليا.

signalEntity(EntityId, string, unknown, TaskHubOptions)

يشير إلى كيان لتنفيذ عملية.

function signalEntity(entityId: EntityId, operationName?: string, operationContent?: unknown, options?: TaskHubOptions): Promise<void>

المعلمات

entityId

EntityId

الكيان الهدف.

operationName

string

اسم العملية.

operationContent

unknown

محتوى العملية.

options

TaskHubOptions

كائن يوفر TaskHubName لمثيل الكيان واسم سلسلة الاتصال المقترنة به

المرتجعات

Promise<void>

startNew(string, StartNewOptions)

بدء مثيل جديد لدالة المنسق المحددة.

إذا كان مثيل تزامن بالمعرف المحدد موجودا بالفعل، استبدال المثيل الموجود بصمت بهذا المثيل الجديد.

function startNew(orchestratorFunctionName: string, options?: StartNewOptions): Promise<string>

المعلمات

orchestratorFunctionName

string

اسم دالة المنسق للبدء.

options

StartNewOptions

عنصر اختياري للتحكم في المنسق المجدول (على سبيل المثال توفير الإدخال، instanceID)

المرتجعات

Promise<string>

معرف مثيل التنسيق الجديد.

terminate(string, string)

إنهاء مثيل تزامن قيد التشغيل.

function terminate(instanceId: string, reason: string): Promise<void>

المعلمات

instanceId

string

معرف مثيل التنسيق المراد إنهائه.

reason

string

سبب إنهاء مثيل التنسيق.

المرتجعات

Promise<void>

وعد يتم حله عند قائمة انتظار رسالة الإنهاء.

إنهاء مثيل التزامن ليس له أي تأثير على أي عمليات تنفيذ دالة نشاط أثناء الطيران أو عمليات التزامن الفرعية التي تم تشغيلها بواسطة مثيل التنسيق الحالي.

waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)

إنشاء استجابة HTTP التي تحتوي إما على حمولة من عناوين URL للإدارة لمثيل غير مكتمل أو تحتوي على الحمولة التي تحتوي على إخراج التنسيق المكتمل.

إذا لم يكتمل التنسيق خلال المهلة المحددة، فستكون استجابة HTTP مطابقة لاستجابة createCheckStatusResponse().

function waitForCompletionOrCreateCheckStatusResponse(request: HttpRequest, instanceId: string, waitOptions?: WaitForCompletionOptions): Promise<HttpResponse>

المعلمات

request

HttpRequest

طلب HTTP الذي قام بتشغيل الدالة الحالية.

instanceId

string

المعرف الفريد للمثيل الذي يجب التحقق منها.

waitOptions

WaitForCompletionOptions

عنصر خيارات يحدد المهلات لطول فترة انتظار الإخراج من الدالة الدائمة ومدى تكرار التحقق من الإخراج.

المرتجعات

Promise<HttpResponse>