RequestOptionsBase interface

パッケージ:

@azure/core-http

すべての操作で使用される options オブジェクトの基本構造について説明します。

プロパティ

abortSignal	中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。
customHeaders	は、要求が送信される前に適用されます。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
serializerOptions	XML 解析/構築の動作をオーバーライドするオプション。
shouldDeserialize	HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。
tracingContext	トレース: スパンの作成時に使用されるコンテキスト。

プロパティの詳細

abortSignal

中止コントローラーのシグナル。 ネットワーク要求の送信と応答の待機の両方を中止するために使用できます。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

customHeaders

は、要求が送信される前に適用されます。

customHeaders?: {[key: string]: string}

プロパティ値

{[key: string]: string}

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

serializerOptions

XML 解析/構築の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

SerializerOptions

shouldDeserialize

HttpOperationResponse を逆シリアル化する必要があるかどうか。 これが未定義の場合は、HttpOperationResponse を逆シリアル化する必要があります。

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

プロパティ値

boolean | (response: HttpOperationResponse) => boolean

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、 AbortError がスローされます。

timeout?: number

プロパティ値

number

tracingContext

トレース: スパンの作成時に使用されるコンテキスト。

tracingContext?: Context

プロパティ値

@azure/core-tracing.Context