CreateHttpPollerOptions interface

パッケージ:

@azure/core-lro

の createPollerオプション。

プロパティ

intervalInMs	サービスに対する新しい要求を行う前にポーリング担当者が待機する時間を定義します。
processResult	LRO の結果を処理する関数。
resolveOnUnsuccessful	操作が失敗した場合、または取り消された場合に例外をスローするかどうかを制御します。
resourceLocationConfig	Swagger の LRO 拡張機能で指定されている場合の、LRO の結果の潜在的な場所。
restoreFrom	既存の一時停止された長時間実行操作を再開するために使用できるシリアル化されたポーリング ャー。
updateState	LRO の状態を処理する関数。
withOperationLocation	サービスによって操作の場所が更新されるたびに呼び出される関数。

プロパティの詳細

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

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