PipelineRequest interface

套件:

@azure/core-rest-pipeline

管線所提出要求的中繼資料。

屬性

abortSignal	稍後用來中止要求。
agent	NODEJS 僅提供自訂 http.Agent/https.Agent 的節點選項。 在瀏覽器中執行時不會執行任何動作。
allowInsecureConnection	如果要求是透過 HTTP 而非 HTTPS 傳送，則設定為 true
body	如果有任何) ，HTTP 本文內容 (
disableKeepAlive	如果不應該重複使用連線。
enableBrowserStreams	BROWSER ONLY 瀏覽器 僅啟用瀏覽器資料流程的選項。 如果已設定此選項，且回應是資料流程，則回應會有 屬性 browserStream ，而不是 blobBody 未定義的屬性。 預設值為 false
formData	模擬瀏覽器表單文章
headers	提出要求時要使用的 HTTP 標頭。
method	提出要求時要使用的 HTTP 方法。
onDownloadProgress	下載進度時引發的回呼。
onUploadProgress	上傳進度時引發的回呼。
proxySettings	Proxy 組態。
requestId	要求的唯一識別碼。 用於記錄和追蹤。
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

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

預設值為 false

enableBrowserStreams?: boolean

屬性值

boolean

formData

模擬瀏覽器表單文章

formData?: FormDataMap

屬性值

FormDataMap

headers

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

headers: HttpHeaders

屬性值

HttpHeaders

method

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

method: HttpMethods

屬性值

HttpMethods

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

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