PipelineRequestOptions interface
要求を初期化するための設定。 Partial とほぼ同じですが、URL は必須です。
プロパティ
| abort |
後で要求を中止するために使用されます。 |
| allow |
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します |
| body | HTTP 本文の内容 (存在する場合) |
| disable |
接続を再利用しない場合。 |
| enable |
ブラウザーのみ Streams API の使用を有効にするブラウザーのみのオプション。 このオプションを設定し、ストリーミングを使用する場合 (「」を参照) 既定値は false です |
| form |
ブラウザー フォームの投稿をシミュレートするには |
| headers | 要求を行うときに使用する HTTP ヘッダー。 |
| method | 要求を行うときに使用する HTTP メソッド。 |
| on |
ダウンロードの進行状況時に発生するコールバック。 |
| on |
アップロードの進行状況時に発生するコールバック。 |
| proxy |
プロキシの構成。 |
| request |
要求の一意の識別子。 ログ記録とトレースに使用されます。 |
| stream |
対応する PipelineResponse 本文をストリームとして扱う必要がある応答状態コードの一覧。 |
| timeout | 要求が自動的に終了するまでの時間 (ミリ秒)。
要求が終了すると、 |
| tracing |
トレースが有効になっているときにスパンを作成するために使用されるオプション。 |
| url | 要求の対象となる URL。 |
| with |
XHR 中に資格情報 (Cookie) を送信する必要がある場合。 既定値は false です。 |
プロパティの詳細
abortSignal
allowInsecureConnection
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します
allowInsecureConnection?: booleanプロパティ値
boolean
body
disableKeepAlive
接続を再利用しない場合。
disableKeepAlive?: booleanプロパティ値
boolean
enableBrowserStreams
ブラウザーのみ
Streams API の使用を有効にするブラウザーのみのオプション。 このオプションを設定し、ストリーミングを使用する場合 (「」を参照)streamResponseStatusCodes、応答のプロパティbrowserStreamblobBodyは未定義になります。
既定値は false です
enableBrowserStreams?: booleanプロパティ値
boolean
formData
headers
method
onDownloadProgress
ダウンロードの進行状況時に発生するコールバック。
onDownloadProgress?: (progress: TransferProgressEvent) => voidプロパティ値
(progress: TransferProgressEvent) => void
onUploadProgress
アップロードの進行状況時に発生するコールバック。
onUploadProgress?: (progress: TransferProgressEvent) => voidプロパティ値
(progress: TransferProgressEvent) => void
proxySettings
requestId
要求の一意の識別子。 ログ記録とトレースに使用されます。
requestId?: stringプロパティ値
string
streamResponseStatusCodes
対応する PipelineResponse 本文をストリームとして扱う必要がある応答状態コードの一覧。
streamResponseStatusCodes?: Set<number>プロパティ値
Set<number>
timeout
要求が自動的に終了するまでの時間 (ミリ秒)。
要求が終了すると、 AbortError がスローされます。
既定値は 0 で、タイムアウトを無効にします。
timeout?: numberプロパティ値
number
tracingOptions
トレースが有効になっているときにスパンを作成するために使用されるオプション。
tracingOptions?: OperationTracingOptionsプロパティ値
url
要求の対象となる URL。
url: stringプロパティ値
string
withCredentials
XHR 中に資格情報 (Cookie) を送信する必要がある場合。 既定値は false です。
withCredentials?: booleanプロパティ値
boolean