PipelineRequest interface
パイプラインによって行われている要求に関するメタデータ。
プロパティ
| abort |
後で要求を中止するために使用されます。 |
| agent | NODEJS のみ カスタム |
| allow |
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します |
| body | HTTP 本文の内容 (存在する場合) |
| disable |
接続を再利用しない場合。 |
| enable |
ブラウザーのみ ブラウザーストリームを有効にするブラウザーのみのオプション。 このオプションが設定され、応答がストリームである場合、応答には、未定義になる 既定値は false です |
| form |
ブラウザー フォームの投稿をシミュレートするには |
| headers | 要求を行うときに使用する HTTP ヘッダー。 |
| method | 要求を行うときに使用する HTTP メソッド。 |
| multipart |
マルチパート要求の本文。 |
| on |
ダウンロードの進行状況時に発生するコールバック。 |
| on |
アップロードの進行状況時に発生するコールバック。 |
| proxy |
プロキシの構成。 |
| request |
要求の一意識別子。 ログ記録とトレースに使用されます。 |
| request |
要求に設定する追加オプション。 これにより、既存のプロパティをオーバーライドしたり、宣言されていないリクエストプロパティを提供したりできます。 有効なプロパティについては、
警告: ここで指定するオプションは、 HttpClient によって要求が送信されたときに、同じ名前のプロパティよりも優先されます。 |
| stream |
対応する PipelineResponse 本文をストリームとして扱う必要がある応答状態コードの一覧。 streamResponseStatusCodes に値が含まれている場合、すべての状態Number.POSITIVE_INFINITYストリームとして扱われます。 |
| timeout | 要求が自動的に終了するまでの時間 (ミリ秒)。
要求が終了すると、 |
| tls |
TLS 認証を構成するための設定 |
| tracing |
作成されたスパンに使用するトレース オプション。 |
| url | 要求を行う URL。 |
| with |
クロスオリジン要求の場合に、ユーザー エージェントが他のドメインから Cookie を送信する必要があるかどうかを示します。 既定値は false です。 |
プロパティの詳細
abortSignal
agent
NODEJS のみ
カスタム http.Agent/https.Agentを提供するノード専用オプション。
ブラウザーで実行しているときは何もしません。
agent?: Agentプロパティ値
allowInsecureConnection
要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します
allowInsecureConnection?: booleanプロパティ値
boolean
body
disableKeepAlive
接続を再利用しない場合。
disableKeepAlive?: booleanプロパティ値
boolean
enableBrowserStreams
ブラウザーのみ
ブラウザーストリームを有効にするブラウザーのみのオプション。 このオプションが設定され、応答がストリームである場合、応答には、未定義になる browserStream ではなく、プロパティ blobBody があります。
既定値は false です
enableBrowserStreams?: booleanプロパティ値
boolean
formData
headers
method
multipartBody
onDownloadProgress
ダウンロードの進行状況時に発生するコールバック。
onDownloadProgress?: (progress: TransferProgressEvent) => voidプロパティ値
(progress: TransferProgressEvent) => void
onUploadProgress
アップロードの進行状況時に発生するコールバック。
onUploadProgress?: (progress: TransferProgressEvent) => voidプロパティ値
(progress: TransferProgressEvent) => void
proxySettings
requestId
要求の一意識別子。 ログ記録とトレースに使用されます。
requestId: stringプロパティ値
string
requestOverrides
要求に設定する追加オプション。 これにより、既存のプロパティをオーバーライドしたり、宣言されていないリクエストプロパティを提供したりできます。
有効なプロパティについては、
- NodeJS https.requestオプション: https://nodejs.org/api/http.html#httprequestoptions-callback
- ブラウザの RequestInit です。 https://developer.mozilla.org/en-US/docs/Web/API/RequestInit
警告: ここで指定するオプションは、 HttpClient によって要求が送信されたときに、同じ名前のプロパティよりも優先されます。
requestOverrides?: Record<string, unknown>プロパティ値
Record<string, unknown>
streamResponseStatusCodes
対応する PipelineResponse 本文をストリームとして扱う必要がある応答状態コードの一覧。 streamResponseStatusCodes に値が含まれている場合、すべての状態Number.POSITIVE_INFINITYストリームとして扱われます。
streamResponseStatusCodes?: Set<number>プロパティ値
Set<number>
timeout
要求が自動的に終了するまでの時間 (ミリ秒)。
要求が終了すると、AbortError がスローされます。
既定値は 0 で、タイムアウトを無効にします。
timeout: numberプロパティ値
number
tlsSettings
tracingOptions
url
要求を行う URL。
url: stringプロパティ値
string
withCredentials
クロスオリジン要求の場合に、ユーザー エージェントが他のドメインから Cookie を送信する必要があるかどうかを示します。 既定値は false です。
withCredentials: booleanプロパティ値
boolean