PipelineRequest interface

套件:

@azure/core-rest-pipeline

管線所提出要求的相關元數據。

屬性

abortSignal	用來在稍後中止要求。
agent	僅限 NODEJS 提供自訂 http.Agent/https.Agent的僅限節點選項。 在瀏覽器中執行時，不會執行任何動作。
allowInsecureConnection	如果要求是透過 HTTP 而不是 HTTPS 傳送，則設定為 true
body	HTTP 本文內容（如果有的話）
disableKeepAlive	如果不應該重複使用連線。
enableBrowserStreams	僅限瀏覽器 僅啟用瀏覽器數據流的瀏覽器選項。 如果已設定此選項，而且回應是數據流，則回應會有屬性 browserStream，而不是未定義 blobBody。 默認值為 false
formData	模擬瀏覽器表單文章
headers	提出要求時要使用的 HTTP 標頭。
method	提出要求時要使用的 HTTP 方法。
multipartBody	多部分要求的本文。
onDownloadProgress	下載進度引發的回呼。
onUploadProgress	上傳進度時引發的回呼。
proxySettings	Proxy 組態。
requestId	要求的唯一標識碼。 用於記錄和追蹤。
requestOverrides	要在請求上設置的其他選項。 這提供了一種覆蓋現有屬性或提供未聲明的請求屬性的方法。 有關可能的有效屬性，請參閱 NodeJS https.request 選項： https://nodejs.org/api/http.html#httprequestoptions-callback 瀏覽器 RequestInit： https://developer.mozilla.org/en-US/docs/Web/API/RequestInit 警告： 當 HttpClient 發送請求時，此處指定的選項將覆蓋任何同名屬性。
streamResponseStatusCodes	回應狀態代碼的清單，其對應的 PipelineResponse 主體應視為數據流。 當 streamResponseStatusCodes 包含值時，Number.POSITIVE_INFINITY任何狀態都會被視為數據流。
timeout	要求在自動終止之前可能需要的毫秒數。 如果要求終止，則會擲回 AbortError。 默認為 0，這會停用逾時。
tlsSettings	設定 TLS 驗證的設定
tracingOptions	用於任何已建立之 Spans 的追蹤選項。
url	要提出要求的 URL。
withCredentials	指出在跨原始來源要求的情況下，使用者代理程式是否應該從其他網域傳送 Cookie。 默認值為 false。

屬性詳細資料

abortSignal

用來在稍後中止要求。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

agent

僅限 NODEJS

提供自訂 http.Agent/https.Agent的僅限節點選項。 在瀏覽器中執行時，不會執行任何動作。

agent?: Agent

屬性值

Agent

allowInsecureConnection

如果要求是透過 HTTP 而不是 HTTPS 傳送，則設定為 true

allowInsecureConnection?: boolean

屬性值

boolean

body

HTTP 本文內容（如果有的話）

body?: RequestBodyType

屬性值

RequestBodyType

disableKeepAlive

如果不應該重複使用連線。

disableKeepAlive?: boolean

屬性值

boolean

enableBrowserStreams

僅限瀏覽器

僅啟用瀏覽器數據流的瀏覽器選項。 如果已設定此選項，而且回應是數據流，則回應會有屬性 browserStream，而不是未定義 blobBody。

默認值為 false

enableBrowserStreams?: boolean

屬性值

boolean

formData

模擬瀏覽器表單文章

formData?: FormDataMap

屬性值

FormDataMap

headers

提出要求時要使用的 HTTP 標頭。

headers: HttpHeaders

屬性值

HttpHeaders

method

提出要求時要使用的 HTTP 方法。

method: HttpMethods

屬性值

HttpMethods

multipartBody

多部分要求的本文。

multipartBody?: MultipartRequestBody

屬性值

MultipartRequestBody

onDownloadProgress

下載進度引發的回呼。

onDownloadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

onUploadProgress

上傳進度時引發的回呼。

onUploadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

proxySettings

Proxy 組態。

proxySettings?: ProxySettings

屬性值

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

設定 TLS 驗證的設定

tlsSettings?: TlsSettings

屬性值

TlsSettings

tracingOptions

用於任何已建立之 Spans 的追蹤選項。

tracingOptions?: OperationTracingOptions

屬性值

OperationTracingOptions

url

要提出要求的 URL。

url: string

屬性值

string

withCredentials

指出在跨原始來源要求的情況下，使用者代理程式是否應該從其他網域傳送 Cookie。 默認值為 false。

withCredentials: boolean

屬性值

boolean