@azure/core-lro package
الواجهات
CreateHttpPollerOptions |
خيارات |
OperationConfig |
تكوينات لكيفية استقصاء العملية والتحقق مما إذا كانت قد انتهت. |
OperationResponse |
نوع استجابة LRO. |
OperationState |
بينما يعمل المحلل كآلية تحكم محلية لبدء التشغيل والانتظار لعملية طويلة الأمد، تقوم OperationState بتوثيق حالة العملية البعيدة طويلة الأمد. يتم تحديثه بعد كل استقصاء. |
PollerLike |
استقصاء لعملية ما. |
RawRequest |
نوع بسيط من الطلب الأولي. |
RawResponse |
نوع بسيط من الاستجابة الأولية. |
RunningOperation |
وصف عملية طويلة الأمد. |
النوع أسماء مستعارة
CancelOnProgress |
يتم استخدام CancelOnProgress كقيمة إرجاع لأسلوب onProgress الخاص ب Poller. عندما يستدعي المستخدم onProgress، يطلب منه تمرير دالة سيتم استدعاؤها كرد اتصال مع البيانات الجديدة المستلمة في كل مرة يتم فيها تحديث عملية الاستقصاء. يقوم onProgress بإرجاع دالة تمنع أي تحديث آخر للوصول إلى رد الاتصال الأصلي. |
OperationStatus |
مجموعة الحالات المحتملة التي يمكن أن تكون فيها العملية في أي وقت. |
ResourceLocationConfig |
الموقع المحتمل لنتيجة LRO إذا تم تحديده بواسطة ملحق LRO في swagger. |
RestorableOperationState |
نوع عملية قابلة للاستعادة طويلة الأمد. |
الوظائف
create |
إنشاء استقصاء يمكن استخدامه لاستقصاء عملية طويلة الأمد. |
deserialize |
إلغاء تسلسل الحالة |
تفاصيل الوظيفة
createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
إنشاء استقصاء يمكن استخدامه لاستقصاء عملية طويلة الأمد.
function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>
المعلمات
- lro
-
RunningOperation<unknown>
وصف العملية طويلة الأمد
- options
-
CreateHttpPollerOptions<TResult, TState>
خيارات لتكوين الاستقصاء
المرتجعات
PollerLike<TState, TResult>
استقصاء تمت تهيئته
deserializeState<TResult, TState>(string)
إلغاء تسلسل الحالة
function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>
المعلمات
- serializedState
-
string
المرتجعات
RestorableOperationState<TResult, TState>