SimplePollerLike interface

الحزمة:

@azure/arm-compute

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

الأساليب

getOperationState()	إرجاع حالة العملية.
getResult()	إرجاع قيمة نتيجة العملية، بغض النظر عن حالة الاستقصاء. يمكن أن ترجع شكلا غير معرف أو غير مكتمل من قيمة TResult النهائية اعتمادا على التنفيذ.
isDone()	إرجاع true إذا انتهى الاستقصاء من الاستقصاء.
isStopped()	إرجاع true إذا تم إيقاف الاستقصاء.
onProgress((state: TState) => void)	يستدعي الاستدعاء المقدم بعد الانتهاء من كل استطلاع، ويرسل الحالة الحالية لعملية المستطلع. يعيد طريقة يمكن استخدامها لإيقاف استقبال التحديثات على دالة إعادة الاتصال المحددة.
poll({ abortSignal?: AbortSignalLike })	يعيد وعدا سيحل بمجرد انتهاء طلب استطلاع واحد. يقوم بذلك عن طريق استدعاء طريقة التحديث لعملية البولر.
pollUntilDone({ abortSignal?: AbortSignalLike })	يعيد وعدا سيحل بمجرد اكتمال العملية الأساسية.
serialize()	يعيد وعدا يمكن استخدامه للنسخة التسلسلية من عملية المستطلع عن طريق استدعاء طريقة التسلسل الخاصة بالعملية.
stopPolling()	يمنع المستطلع من الاستمرار في الاستطلاع. يرجى ملاحظة أن هذا سيوقف فقط الاستطلاعات على جانب العميل
submitted()	انتظر تقديم الاستطلاع.
toString()	يرجع تمثيلا نصيا لعملية المستشعر. مشابه للتسلسل لكنه يعيد سلسلة نصية.

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

getOperationState()

إرجاع حالة العملية.

function getOperationState(): TState

المرتجعات

TState

getResult()

إرجاع قيمة نتيجة العملية، بغض النظر عن حالة الاستقصاء. يمكن أن ترجع شكلا غير معرف أو غير مكتمل من قيمة TResult النهائية اعتمادا على التنفيذ.

function getResult(): undefined | TResult

المرتجعات

undefined | TResult

isDone()

إرجاع true إذا انتهى الاستقصاء من الاستقصاء.

function isDone(): boolean

المرتجعات

boolean

isStopped()

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use abortSignal status to track this instead.

إرجاع true إذا تم إيقاف الاستقصاء.

function isStopped(): boolean

المرتجعات

boolean

onProgress((state: TState) => void)

يستدعي الاستدعاء المقدم بعد الانتهاء من كل استطلاع، ويرسل الحالة الحالية لعملية المستطلع.

يعيد طريقة يمكن استخدامها لإيقاف استقبال التحديثات على دالة إعادة الاتصال المحددة.

function onProgress(callback: (state: TState) => void): CancelOnProgress

المعلمات

callback

(state: TState) => void

المرتجعات

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

يعيد وعدا سيحل بمجرد انتهاء طلب استطلاع واحد. يقوم بذلك عن طريق استدعاء طريقة التحديث لعملية البولر.

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>

المعلمات

options

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

يعيد وعدا سيحل بمجرد اكتمال العملية الأساسية.

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

المعلمات

pollOptions

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<TResult>

serialize()

يعيد وعدا يمكن استخدامه للنسخة التسلسلية من عملية المستطلع عن طريق استدعاء طريقة التسلسل الخاصة بالعملية.

function serialize(): Promise<string>

المرتجعات

Promise<string>

stopPolling()

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use abortSignal to stop polling instead.

يمنع المستطلع من الاستمرار في الاستطلاع. يرجى ملاحظة أن هذا سيوقف فقط الاستطلاعات على جانب العميل

function stopPolling()

submitted()

انتظر تقديم الاستطلاع.

function submitted(): Promise<void>

المرتجعات

Promise<void>

toString()

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use serialize() instead.

يرجع تمثيلا نصيا لعملية المستشعر. مشابه للتسلسل لكنه يعيد سلسلة نصية.

function toString(): string

المرتجعات

string