@azure/core-rest-pipeline package
類別
| RestError |
失敗管線要求的自訂錯誤類型。 |
介面
| AddPipelineOptions |
將原則新增至管線時的選項。 用來表達其他原則的相依性。 |
| Agent |
與 NodeJS |
| AuthorizeRequestOnChallengeOptions |
傳送至 authorizeRequestOnChallenge 回呼的選項 |
| AuthorizeRequestOptions |
傳送至 authorizeRequest 回呼的選項 |
| AuxiliaryAuthenticationHeaderPolicyOptions |
設定 auxiliaryAuthenticationHeaderPolicy 的選項 |
| BearerTokenAuthenticationPolicyOptions |
設定 bearerTokenAuthenticationPolicy 的選項 |
| ChallengeCallbacks |
覆寫 連續存取評估 挑戰處理的選項。 |
| DefaultRetryPolicyOptions |
控制如何重試失敗要求的選項。 |
| ExponentialRetryPolicyOptions |
控制如何重試失敗要求的選項。 |
| HttpClient |
代表管線提出 HTTP 要求之用戶端的必要介面。 |
| HttpHeaders |
表示要求/回應上的一組 HTTP 標頭。 標頭名稱會視為不區分大小寫。 |
| InternalPipelineOptions |
定義用來設定 SDK 用戶端之 HTTP 管線內部選項的選項。 |
| KeyObject |
與 NodeJS |
| LogPolicyOptions |
設定 logPolicy 的選項。 |
| Pipeline |
表示對 URL 提出 HTTP 要求的管線。 管線可以有多個原則來管理對伺服器進行之前和之後操作每個要求。 |
| PipelineOptions |
定義用來設定 SDK 用戶端 HTTP 管線的選項。 |
| PipelinePolicy |
管線原則會隨著要求流經管線而操作。 其概念上是一種中介軟體，允許在提出要求之前修改要求，以及收到要求時的回應。 |
| PipelineRequest |
管線所提出要求的中繼資料。 |
| PipelineRequestOptions |
初始化要求的設定。 幾乎相當於 Partial，但 URL 是必要的。 |
| PipelineResponse |
管線所接收之回應的相關中繼資料。 |
| PipelineRetryOptions |
控制如何重試失敗要求的選項。 |
| ProxySettings |
僅) 設定傳出要求的 Proxy 選項 (Node.js。 |
| PxfObject |
與 NodeJS 相容的 |
| RedirectPolicyOptions |
重新導向回應處理方式的選項。 |
| RestErrorOptions |
RestError 支援的選項。 |
| RetryInformation |
提供給重試策略的資訊，說明重試原則的目前進度。 |
| RetryModifiers |
可以修改重試原則行為的屬性。 |
| RetryPolicyOptions |
retryPolicy的選項 |
| RetryStrategy |
重試策略是要定義是否要重試，以及如何重試。 |
| SystemErrorRetryPolicyOptions |
控制如何重試失敗要求的選項。 |
| TelemetryOptions |
定義用來設定常見遙測和追蹤資訊的選項 |
| ThrottlingRetryPolicyOptions |
控制如何重試失敗要求的選項。 |
| TlsSettings |
表示 TLS 驗證的憑證。 |
| TracingPolicyOptions |
設定追蹤原則的選項。 |
| UserAgentPolicyOptions |
將使用者代理程式詳細資料新增至傳出要求的選項。 |
類型別名
| FormDataMap |
提供表單資料的簡單物件，就像從瀏覽器表單一樣。 |
| FormDataValue |
每個表單資料輸入都可以是 Blob) 瀏覽器中的字串或 (。 |
| HttpMethods |
提出要求時所要使用的支援 HTTP 方法。 |
| PipelinePhase |
原則會分階段執行。 執行順序為：
|
| RawHttpHeaders |
以簡單 JSON 物件表示的 HttpHeaders 集合。 |
| RawHttpHeadersInput |
輸入的 HttpHeaders 集合，以簡單的 JSON 物件表示。 |
| RequestBodyType |
要求上支援的主體類型。 NodeJS.ReadableStream 和 () = > NodeJS.ReadableStream 僅限 Node。 Blob、ReadableStream 和 () = > ReadableStream 只是瀏覽器。 |
| SendRequest |
用來提出管線要求和接收回應的簡單介面。 |
| TransferProgressEvent |
引發以回應上傳或下載進度。 |
函數
函式詳細資料
auxiliaryAuthenticationHeaderPolicy(AuxiliaryAuthenticationHeaderPolicyOptions)
要標頭的外部權杖 x-ms-authorization-auxiliary 原則。
建立跨租使用者應用程式時，可能需要處理不同租使用者中資源的驗證要求。
您可以看到 ARM 檔 ，以瞭解此功能的運作方式
function auxiliaryAuthenticationHeaderPolicy(options: AuxiliaryAuthenticationHeaderPolicyOptions): PipelinePolicy參數
傳回
bearerTokenAuthenticationPolicy(BearerTokenAuthenticationPolicyOptions)
可從 TokenCredential 實作要求權杖的原則，然後將它套用至要求的 Authorization 標頭作為持有人權杖。
function bearerTokenAuthenticationPolicy(options: BearerTokenAuthenticationPolicyOptions): PipelinePolicy參數
傳回
createDefaultHttpClient()
createEmptyPipeline()
createHttpHeaders(RawHttpHeadersInput)
建立符合 介面的物件 HttpHeaders 。
function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders參數
- rawHeaders
- RawHttpHeadersInput
代表初始標頭的簡單物件
傳回
createPipelineFromOptions(InternalPipelineOptions)
建立具有一組預設可自訂原則的新管線。
function createPipelineFromOptions(options: InternalPipelineOptions): Pipeline參數
- options
- InternalPipelineOptions
設定自訂管線的選項。
傳回
createPipelineRequest(PipelineRequestOptions)
使用指定的選項建立新的管線要求。 這個方法是允許輕鬆設定預設值，而不需要。
function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest參數
- options
- PipelineRequestOptions
用來建立要求的選項。
傳回
decompressResponsePolicy()
根據 Accept-Encoding 標頭啟用回應解壓縮的原則 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
function decompressResponsePolicy(): PipelinePolicy傳回
defaultRetryPolicy(DefaultRetryPolicyOptions)
根據三個策略重試的原則：
- 當伺服器傳送具有 Retry-After 標頭的 429 回應時。
- 當基礎傳輸層發生錯誤時， (例如 DNS 查閱失敗) 。
- 或者，如果傳出要求失敗，它會以指數方式增加延遲重試。
function defaultRetryPolicy(options?: DefaultRetryPolicyOptions): PipelinePolicy參數
- options
- DefaultRetryPolicyOptions
傳回
exponentialRetryPolicy(ExponentialRetryPolicyOptions)
嘗試在引進指數增加延遲時重試要求的原則。
function exponentialRetryPolicy(options?: ExponentialRetryPolicyOptions): PipelinePolicy參數
- options
- ExponentialRetryPolicyOptions
設定重試邏輯的選項。
傳回
formDataPolicy()
getDefaultProxySettings(string)
這個方法會將 Proxy URL ProxySettings 轉換成 ，以搭配 ProxyPolicy 使用。
如果未指定任何引數，它會嘗試從環境變數 HTTPS_PROXY 或 HTTP_PROXY 剖析 Proxy URL。
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined參數
- proxyUrl
-
string
要使用的 Proxy URL。 可能包含驗證資訊。
傳回
ProxySettings | undefined
isRestError(unknown)
RestError 的 Typeguard
function isRestError(e: unknown): e參數
- e
-
unknown
catch 子句攔截到的內容。
傳回
e
logPolicy(LogPolicyOptions)
記錄所有要求和回應的原則。
function logPolicy(options?: LogPolicyOptions): PipelinePolicy參數
- options
- LogPolicyOptions
設定 logPolicy 的選項。
傳回
ndJsonPolicy()
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })
原則，允許將 Proxy 設定套用至所有要求。 如果未傳遞靜態設定，則會從HTTPS_PROXY或HTTP_PROXY環境變數擷取它們。
function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): PipelinePolicy參數
- proxySettings
- ProxySettings
ProxySettings 用於每個要求。
- options
-
{ customNoProxyList?: string[] }
例如，自訂NO_PROXY模式的其他設定
傳回
redirectPolicy(RedirectPolicyOptions)
要遵循伺服器位置標頭的原則，以支援伺服器端重新導向。 在瀏覽器中，不會使用此原則。
function redirectPolicy(options?: RedirectPolicyOptions): PipelinePolicy參數
- options
- RedirectPolicyOptions
控制原則行為的選項。
傳回
retryPolicy(RetryStrategy[], RetryPolicyOptions)
retryPolicy 是一般原則，可啟用符合特定條件時的重試要求
function retryPolicy(strategies: RetryStrategy[], options?: RetryPolicyOptions): PipelinePolicy參數
- strategies
- options
- RetryPolicyOptions
傳回
setClientRequestIdPolicy(string)
每個 PipelineRequest 在建立時都會取得唯一識別碼。 此原則會透過 HTTP 標頭傳遞該唯一識別碼，以提供更好的遙測和追蹤。
function setClientRequestIdPolicy(requestIdHeaderName?: string): PipelinePolicy參數
- requestIdHeaderName
-
string
要傳遞要求識別碼的標頭名稱。
傳回
systemErrorRetryPolicy(SystemErrorRetryPolicyOptions)
特別要處理基礎傳輸層錯誤 (例如 DNS 查閱失敗) ，而不是伺服器本身可重試的錯誤碼的重試原則。
function systemErrorRetryPolicy(options?: SystemErrorRetryPolicyOptions): PipelinePolicy參數
- options
- SystemErrorRetryPolicyOptions
自訂原則的選項。
傳回
throttlingRetryPolicy(ThrottlingRetryPolicyOptions)
當伺服器傳送具有 Retry-After 標頭的 429 回應時，重試的原則。
若要深入瞭解，請參閱 https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits 、 https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits 和 https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
function throttlingRetryPolicy(options?: ThrottlingRetryPolicyOptions): PipelinePolicy參數
- options
- ThrottlingRetryPolicyOptions
設定重試邏輯的選項。
傳回
tlsPolicy(TlsSettings)
取得管線原則，將用戶端憑證新增至 HttpClient 代理程式以進行驗證。
function tlsPolicy(tlsSettings?: TlsSettings): PipelinePolicy參數
- tlsSettings
- TlsSettings
傳回
tracingPolicy(TracingPolicyOptions)
針對具有 SpanOptions 且具有父代之管線所提出之每個要求的 OpenTelemetry Spans，建立 OpenTelemetry Spans 的簡單原則。 不會記錄沒有父 Span 的要求。
function tracingPolicy(options?: TracingPolicyOptions): PipelinePolicy參數
- options
- TracingPolicyOptions
設定追蹤原則所記錄遙測的選項。
傳回
userAgentPolicy(UserAgentPolicyOptions)
原則，設定 User-Agent 標頭 (或對等) 以反映程式庫版本。
function userAgentPolicy(options?: UserAgentPolicyOptions): PipelinePolicy參數
- options
- UserAgentPolicyOptions
自訂使用者代理程式值的選項。