@azure/core-lro package

الفصول

LroEngine	محرك LRO، فئة تقوم بإجراء الاستقصاء.
Poller	فئة تمثل تعريف البرنامج الذي يستقصي من خلال الطلبات المتتالية حتى يصل إلى حالة الاكتمال. يمكن تنفيذ الاستقصاء يدويا، عن طريق التحقق من الطلب عن طريق الطلب عن طريق استدعاء الأسلوب poll() بشكل متكرر، حتى اكتمال تشغيله. كما يوفر طريقة للانتظار حتى تكتمل العملية، عن طريق الاتصال pollUntilDone() والانتظار حتى تنتهي العملية. كما يمكن لجهات الاقتراع طلب إلغاء العملية الجارية التي توفر لها العملية الأساسية طويلة الأمد. const poller = new MyPoller(); // Polling just once: await poller.poll(); // We can try to cancel the request here, by calling: // // await poller.cancelOperation(); // // Getting the final result: const result = await poller.pollUntilDone(); يتم تعريف Poller بنوعين، نوع يمثل حالة الاستقصاء، والذي يجب أن يتضمن مجموعة أساسية من الخصائص من PollOperationState<TResult>، ونوع الإرجاع المحدد بواسطة TResult، والذي يمكن أن يكون أي شيء. تقوم فئة Poller بتنفيذ الواجهة PollerLike ، والتي تسمح لتطبيقات الاستقصاء بتجنب الاضطرار إلى تصدير فئة Poller مباشرة، وبدلا من ذلك فقط تصدير الاستقصاء الذي تم إنشاء مثيل له بالفعل بنوع PollerLike. class Client { public async makePoller: PollerLike<MyOperationState, MyResult> { const poller = new MyPoller({}); // It might be preferred to return the poller after the first request is made, // so that some information can be obtained right away. await poller.poll(); return poller; } } const poller: PollerLike<MyOperationState, MyResult> = myClient.makePoller(); يمكن إنشاء الاستقصاء من خلال الدالة الإنشائية الخاصة به، ثم يمكن التحقق منه حتى يكتمل. في أي وقت، يمكن الحصول على حالة الاستقصاء دون تأخير من خلال أسلوب getOperationState. في أي وقت، يمكن طلب النماذج الوسيطة لنوع النتيجة دون تأخير. بمجرد وضع علامة على العملية الأساسية على أنها مكتملة، سيتوقف الاستقصاء وسيتم إرجاع القيمة النهائية. const poller = myClient.makePoller(); const state: MyOperationState = poller.getOperationState(); // The intermediate result can be obtained at any time. const result: MyResult | undefined = poller.getResult(); // The final result can only be obtained after the poller finishes. const result: MyResult = await poller.pollUntilDone();
PollerCancelledError	عند إلغاء العملية، سيتم رفض الاستقصاء بمثيل PollerCancelledError.
PollerStoppedError	عند إيقاف الاستقصاء يدويا من خلال stopPolling الأسلوب، سيتم رفض الاستقصاء بمثيل PollerStoppedError.

الواجهات

CreateHttpPollerOptions	خيارات ل createPoller.
LongRunningOperation	وصف عملية طويلة الأمد.
LroEngineOptions	خيارات لاستطلاع LRO.
LroResponse	نوع استجابة LRO.
OperationState	بينما يعمل الاستقصاء كآلية تحكم محلية لبدء التشغيل وانتظار عملية طويلة الأمد، توثق OperationState حالة العملية البعيدة طويلة المدى. يتم تحديثه بعد كل استقصاء.
PollOperation	PollOperation هي واجهة تحدد كيفية تحديث المرجع المحلي لحالة العملية البعيدة طويلة الأمد، بالإضافة إلى كيفية طلب إلغاء نفس العملية. كما أن لديها طريقة لتسلسل العملية بحيث يمكن تخزينها واستئنافها في أي وقت.
PollOperationState	يحتوي PollOperationState على قائمة تم استطلاعها لأصغر مجموعة من الخصائص اللازمة لتحديد أي استقصاء عملية طويلة الأمد. بينما تعمل فئة Poller كآلية تحكم محلية لبدء التشغيل والانتظار والإلغاء المحتمل لعملية تشغيل طويلة، توثق PollOperationState حالة عملية التشغيل الطويل البعيد. يجب تحديثه على الأقل عند بدء العملية، ومتى تنتهي، ومتى يتم إلغاؤها. على الرغم من ذلك، يمكن أن يكون للتطبيقات أي عدد آخر من الخصائص التي يمكن تحديثها لأسباب أخرى.
PollerLike	تمثيل تجريدي لأداة الاستقصاء، تهدف إلى عرض الحد الأدنى فقط من واجهة برمجة التطبيقات التي يحتاج المستخدم إلى العمل معها.
RawResponse	نوع بسيط من الاستجابة الأولية.
SimplePollerLike	واجهة استطلاع بسيطة.

النوع أسماء مستعارة

CancelOnProgress	يتم استخدام CancelOnProgress كقيمة إرجاع لأسلوب onProgress الخاص ب Poller. عندما يستدعي المستخدم onProgress، يطلب منه تمرير دالة سيتم استدعاؤها كرد اتصال مع البيانات الجديدة المستلمة في كل مرة يتم فيها تحديث عملية الاستقصاء. يقوم onProgress بإرجاع دالة ستمنع أي تحديث آخر للوصول إلى رد الاتصال الأصلي.
LroResourceLocationConfig	الموقع المحتمل لنتيجة LRO إذا تم تحديده بواسطة ملحق LRO في swagger.
OperationStatus	مجموعة الحالات المحتملة التي يمكن أن تكون فيها العملية في أي وقت.
PollProgressCallback	PollProgressCallback هو نوع دالات رد الاتصال المرسلة إلى onProgress. ستتلقى هذه الدالات TState التي يتم تعريفها من خلال تنفيذ فئة Poller.

الوظائف

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

إنشاء استقصاء يمكن استخدامه لاستقصاء عملية طويلة الأمد.

تفاصيل الوظيفة

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

إنشاء استقصاء يمكن استخدامه لاستقصاء عملية طويلة الأمد.

function createHttpPoller<TResult, TState>(lro: LongRunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): Promise<SimplePollerLike<TState, TResult>>

المعلمات

lro

LongRunningOperation<unknown>

وصف العملية طويلة الأمد

options

CreateHttpPollerOptions<TResult, TState>

خيارات لتكوين الاستقصاء

المرتجعات

Promise<SimplePollerLike<TState, TResult>>

مدقق تم تهيئته