PipelineRequest interface

後で要求を中止するために使用されます。

abortSignal?: AbortSignalLike

プロパティ値

NODEJS のみ

カスタム http.Agent/https.Agentを提供するノード専用オプション。 ブラウザーで実行しているときは何もしません。

agent?: Agent

プロパティ値

要求が HTTPS ではなく HTTP 経由で送信される場合は true に設定します

allowInsecureConnection?: boolean

プロパティ値

HTTP 本文の内容 (存在する場合)

body?: RequestBodyType

プロパティ値

接続を再利用しない場合。

disableKeepAlive?: boolean

プロパティ値

ブラウザーのみ

ブラウザーストリームを有効にするブラウザーのみのオプション。 このオプションが設定され、応答がストリームである場合、応答には、未定義になる browserStream ではなく、プロパティ blobBody があります。

既定値は false です

enableBrowserStreams?: boolean

プロパティ値

ブラウザー フォームの投稿をシミュレートするには

formData?: FormDataMap

プロパティ値

要求を行うときに使用する HTTP ヘッダー。

headers: HttpHeaders

プロパティ値

要求を行うときに使用する HTTP メソッド。

method: HttpMethods

プロパティ値

マルチパート要求の本文。

multipartBody?: MultipartRequestBody

プロパティ値

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

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

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

プロキシの構成。

proxySettings?: ProxySettings

プロパティ値

要求の一意識別子。 ログ記録とトレースに使用されます。

requestId: string

プロパティ値

要求に設定する追加オプション。 これにより、既存のプロパティをオーバーライドしたり、宣言されていないリクエストプロパティを提供したりできます。

有効なプロパティについては、

• 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>

プロパティ値

対応する PipelineResponse 本文をストリームとして扱う必要がある応答状態コードの一覧。 streamResponseStatusCodes に値が含まれている場合、すべての状態Number.POSITIVE_INFINITYストリームとして扱われます。

streamResponseStatusCodes?: Set<number>

プロパティ値

要求が自動的に終了するまでの時間 (ミリ秒)。 要求が終了すると、AbortError がスローされます。 既定値は 0 で、タイムアウトを無効にします。

timeout: number

プロパティ値

TLS 認証を構成するための設定

tlsSettings?: TlsSettings

プロパティ値

作成されたスパンに使用するトレース オプション。

tracingOptions?: OperationTracingOptions

プロパティ値

要求を行う URL。

url: string

プロパティ値

クロスオリジン要求の場合に、ユーザー エージェントが他のドメインから Cookie を送信する必要があるかどうかを示します。 既定値は false です。

withCredentials: boolean

プロパティ値