CreateHttpPollerOptions interface

套件:

@azure/core-lro

createPoller的選項。

屬性

baseUrl	發出請求時要使用的基本 URL。
intervalInMs	定義輪詢器在向服務提出新要求之前要等候的時間。
processResult	用來處理 LRO 結果的函式。
resolveOnUnsuccessful	控制如果作業失敗或已取消，是否擲回例外狀況。
resourceLocationConfig	如果由 Swagger 中的 LRO 延伸模組所指定，則為 LRO 結果的潛在位置。
restoreFrom	串行化輪詢器，可用來繼續現有的暫停長時間執行作業。
skipFinalGet	跳過通常會獲取最終資源的最終 GET 請求的標誌
updateState	用來處理 LRO 狀態的函式。
withOperationLocation	每次服務更新作業位置時要呼叫的函式。

屬性詳細資料

baseUrl

發出請求時要使用的基本 URL。

baseUrl?: string

屬性值

string

intervalInMs

定義輪詢器在向服務提出新要求之前要等候的時間。

intervalInMs?: number

屬性值

number

processResult

用來處理 LRO 結果的函式。

processResult?: (result: unknown, state: TState) => Promise<TResult>

屬性值

(result: unknown, state: TState) => Promise<TResult>

resolveOnUnsuccessful

控制如果作業失敗或已取消，是否擲回例外狀況。

resolveOnUnsuccessful?: boolean

屬性值

boolean

resourceLocationConfig

如果由 Swagger 中的 LRO 延伸模組所指定，則為 LRO 結果的潛在位置。

resourceLocationConfig?: ResourceLocationConfig

屬性值

ResourceLocationConfig

restoreFrom

串行化輪詢器，可用來繼續現有的暫停長時間執行作業。

restoreFrom?: string

屬性值

string

skipFinalGet

跳過通常會獲取最終資源的最終 GET 請求的標誌

skipFinalGet?: boolean

屬性值

boolean

updateState

用來處理 LRO 狀態的函式。

updateState?: (state: TState, response: OperationResponse<unknown, RawRequest>) => void

屬性值

(state: TState, response: OperationResponse<unknown, RawRequest>) => void

withOperationLocation

每次服務更新作業位置時要呼叫的函式。

withOperationLocation?: (operationLocation: string) => void

屬性值

(operationLocation: string) => void