PipelineRequest interface

パイプラインによって行われる要求に関するメタデータ。

プロパティ

abortSignal

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

agent

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

allowInsecureConnection

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

body

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

disableKeepAlive

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

enableBrowserStreams

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

既定値は false です

formData

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

headers

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

method

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

onDownloadProgress

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

onUploadProgress

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

proxySettings

プロキシの構成。

requestId

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

streamResponseStatusCodes

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

timeout

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

tlsSettings

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

tracingOptions

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

url

要求の対象となる URL。

withCredentials

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

プロパティの詳細

abortSignal

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

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

agent

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

agent?: Agent

プロパティ値

allowInsecureConnection

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

allowInsecureConnection?: boolean

プロパティ値

boolean

body

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

body?: RequestBodyType

プロパティ値

disableKeepAlive

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

disableKeepAlive?: boolean

プロパティ値

boolean

enableBrowserStreams

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

既定値は false です

enableBrowserStreams?: boolean

プロパティ値

boolean

formData

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

formData?: FormDataMap

プロパティ値

headers

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

headers: HttpHeaders

プロパティ値

method

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

method: HttpMethods

プロパティ値

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

proxySettings

プロキシの構成。

proxySettings?: ProxySettings

プロパティ値

requestId

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

requestId: string

プロパティ値

string

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

プロパティ値

Set<number>

timeout

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

timeout: number

プロパティ値

number

tlsSettings

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

tlsSettings?: TlsSettings

プロパティ値

tracingOptions

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

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

url

要求の対象となる URL。

url: string

プロパティ値

string

withCredentials

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

withCredentials: boolean

プロパティ値

boolean