@azure/core-http package
類別
| AccessTokenRefresher |
如果我們目前未等候新的權杖，可協助 core-HTTP 權杖驗證原則要求新的權杖。 |
| ApiKeyCredentials |
使用 API 金鑰向服務進行驗證。 |
| BaseRequestPolicy |
從中衍生所有要求原則的基類。 |
| BasicAuthenticationCredentials |
使用使用者名稱和密碼進行驗證的簡單 <xref:ServiceClientCredential> 。 |
| DefaultHttpClient |
使用 的 |
| ExpiringAccessTokenCache |
提供 AccessTokenCache 實作，這個實作會清除已快取 的 AccessToken在 passsOnTimestamp 之後的 。 |
| HttpHeaders |
HTTP 標頭索引鍵/值組的集合。 |
| RequestPolicyOptions |
建立 RequestPolicy 時可以使用的選擇性屬性。 |
| RestError |
從 HTTP 要求到服務端點所造成的錯誤。 |
| Serializer |
用來將原始回應物件對應至最終圖形。 協助封裝和解除封裝日期和其他不是 JSON 內建的編碼類型。 也允許從標頭提取值，以及插入預設值和常數。 |
| ServiceClient |
ServiceClient 會傳送服務要求並接收回應。 |
| TopicCredentials | |
| URLBuilder |
處理建立、修改及剖析 URL 的類別。 |
| URLQuery |
處理 URLBuilder 查詢部分的類別。 |
| WebResource |
建立新的 WebResource 物件。 這個類別提供 REST 呼叫的抽象概念，其方式是程式庫/實作無從驗證，並包裝必要的屬性來起始要求。 |
介面
| AbortSignalLike |
允許在引發「中止」事件時中止要求。 與瀏覽器內建 AbortSignal 和通用 polyfills 相容。 |
| AccessToken |
表示具有到期時間的存取權杖。 |
| AccessTokenCache |
提供從 TokenCredential 傳回之 AccessToken 的快取。 |
| ApiKeyCredentialOptions |
描述建立 ApiKeyCredentials 實例時要提供的選項 |
| BaseMapper |
對應程式的基底定義。 可用於 XML 和純 JavaScript 物件。 |
| CompositeMapper |
由其他對應程式組成的對應程式。 |
| CompositeMapperType |
協助建置對應程式，描述如何根據其他對應器來對應物件的一組屬性。 只有下列其中一個屬性應該存在： |
| DeserializationContentTypes |
內容類型，指出作業回應應該以特定方式還原序列化。 |
| DeserializationOptions |
設定 API 回應還原序列化的選項。 |
| DictionaryMapper |
對應程式，描述做為索引鍵/值組的一般 JavaScript 物件。 |
| DictionaryMapperType |
協助建置對應程式，描述如何剖析對應值的字典。 |
| EnumMapper |
描述列舉值的對應程式。 |
| EnumMapperType |
協助建置描述如何剖析列舉值的對應程式。 |
| GetTokenOptions |
定義 TokenCredential.getToken 的選項。 |
| HttpClient |
介面，可傳送 HttpRequests 並接收承諾的 HttpResponses。 |
| HttpHeader |
HttpHeaders 集合中的個別標頭。 |
| HttpHeadersLike |
HTTP 標頭索引鍵/值組的集合。 |
| HttpOperationResponse |
HTTP 要求和回應的包裝函式物件。 當回應本文以 JSON 或 XML 接收時，還原序列化物件會儲存在 |
| HttpPipelineLogger |
可新增至 HttpPipeline 的記錄器。 這可讓每個 RequestPolicy 記錄可用於偵錯用途的訊息。 |
| HttpResponse |
一律會出現 HTTP 回應上的屬性。 |
| InternalPipelineOptions |
定義用來設定 SDK 用戶端之 HTTP 管線內部選項的選項。 |
| KeepAliveOptions |
未來要求應如何維護 HTTP 連線的選項。 |
| LogPolicyOptions |
要傳遞至 logPolicy的選項。 根據預設，只會記錄一組標頭清單，但可以設定此清單。 永遠不會記錄要求和回應主體。 |
| MapperConstraints |
各種值條件約束的描述，例如整數範圍和字串正則運算式。 |
| OperationArguments |
套用至作業單一調用的屬性集合。 |
| OperationOptions |
所有作業的基底選項類型。 |
| OperationParameter |
所有 Operation 參數擴充的通用介面。 |
| OperationQueryParameter |
作業的參數，該作業會新增為作業的 HTTP 要求查詢參數。 |
| OperationRequestOptions |
允許設定 SDK 作業所提出 HTTP 要求處理的選項。 |
| OperationResponse |
可從單一狀態碼的作業要求傳回的 OperationResponse。 |
| OperationSpec |
定義如何透過 HTTP 執行特定服務作業的規格，包括如何將要求資訊正確序列化至 ，並將回應資訊還原序列化為 ServiceClient可傳回的物件承載。 |
| OperationURLParameter |
作業的參數，將取代為作業的要求 URL。 |
| ParameterValue |
RequestPrepareOptions 中針對路徑或查詢參數提供的 Parameter 值 |
| PipelineOptions |
定義用來設定 SDK 用戶端 HTTP 管線的選項。 |
| PolymorphicDiscriminator |
用來厘清區分的類型等位。 例如，如果回應可以有許多圖形，但也包含「種類」欄位 (或類似的) ，該欄位可用來判斷如何將回應還原序列化為正確的類型。 |
| ProxySettings |
僅) 設定傳出要求的 Proxy 選項 (Node.js。 |
| RedirectOptions |
如何處理重新導向回應的選項。 |
| RequestOptionsBase |
描述將用於每個作業之 options 物件的基底結構。 |
| RequestPolicy |
要求原則的基礎結構。 |
| RequestPolicyOptionsLike |
建立 RequestPolicy 時可以使用的選擇性屬性。 |
| RequestPrepareOptions |
準備傳出 HTTP 要求的選項。 |
| RestResponse |
REST 呼叫的扁平化回應。
包含基礎HttpOperationResponse以及 、 |
| RetryOptions |
控制如何重試失敗要求的選項。 |
| SequenceMapper |
描述陣列的對應程式。 |
| SequenceMapperType |
協助建置描述如何剖析對應值序列的對應程式。 |
| SerializerOptions |
管理 xml 剖析器和產生器行為的選項。 |
| ServiceCallback | |
| ServiceClientCredentials |
表示物件或類別， |
| ServiceClientOptions |
建立用戶端時要提供的選項。 |
| SimpleMapperType |
簡單對應程式的型別。 |
| TokenCredential |
表示能夠提供驗證權杖的認證。 |
| TracingPolicyOptions |
自訂追蹤原則的選項。 |
| UrlParameterValue |
表示 URL 參數值的介面。 |
| UserAgentOptions |
將使用者代理程式詳細資料新增至傳出要求的選項。 |
| WebResourceLike |
要對遠端伺服器提出 HTTP 要求的描述。 |
類型別名
| Authenticator |
接收挑戰並解決具有字串標記之承諾的函式。 |
| CommonRequestInfo |
呼叫 |
| CommonRequestInit |
物件，包含傳出 HTTP 要求的相關資訊。 |
| CommonResponse |
物件，包含傳入 HTTP 回應的相關資訊。 |
| HttpMethods |
支援的 HTTP 方法清單。 |
| HttpRequestBody |
可能的 HTTP 要求本文類型 |
| Mapper |
對應程式是程式庫中所用資料模型的定義。 這些資料模型是回應或參數中作業或用戶端定義的一部分。 |
| MapperType |
對應程式的類型。 包含已知的對應程式。 |
| ParameterPath |
描述如何存取指定物件資料來源中特定屬性的路徑。 可以是單一屬性名稱、代表巢狀屬性名稱的陣列，或複雜物件值案例中路徑為一組多個具名屬性。 |
| ProxyOptions |
ProxySettings的別名，以供日後使用。 |
| RawHttpHeaders |
以簡單 JSON 物件表示的 HttpHeaders 集合。 |
| RequestPolicyFactory |
建立使用所提供 nextPolicy 之每個要求的新 RequestPolicy。 |
| TelemetryInfo |
遙測資訊。 要包含在User-Agent字串內的索引鍵/值組。 |
| TransferProgressEvent |
引發以回應上傳或下載進度。 |
列舉
| HttpPipelineLogLevel |
可與 HttpPipelineLogger 搭配使用的不同記錄層級。 |
| QueryCollectionFormat |
將用來將值陣列聯結在一起的查詢參數值格式。 |
| RetryMode |
描述重試模式類型。 目前僅支援指數。 |
函數
函式詳細資料
applyMixins(unknown, any[])
將 sourceCtors 原型上的屬性套用至 targetCtor 的原型
function applyMixins(targetCtorParam: unknown, sourceCtors: any[])參數
- targetCtorParam
-
unknown
- sourceCtors
-
any[]
需要從中取得屬性的來源物件陣列。
bearerTokenAuthenticationPolicy(TokenCredential, string | string[])
為將持有人權杖套用至要求 Authorization 標頭的 RequestPolicy 建立新的處理站。
function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory參數
- credential
- TokenCredential
可提供持有人權杖的 TokenCredential 實作。
- scopes
-
string | string[]
持有人權杖套用的範圍。
傳回
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)
根據指定的選項建立 HTTP 管線。
function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions參數
- pipelineOptions
- InternalPipelineOptions
定義用來在 SDK 用戶端的 HTTP 管線中設定原則的選項。
- authPolicyFactory
- RequestPolicyFactory
用於簽署要求的選擇性驗證原則處理站。
傳回
一組可傳遞以建立新 ServiceClient的選項。
delay(number, DelayOptions)
setTimeout 的包裝函式，可解析 timeInMs 毫秒之後的承諾。
function delay(timeInMs: number, options?: DelayOptions): Promise<void>參數
- timeInMs
-
number
要延遲的毫秒數。
- options
- DelayOptions
延遲的選項 - 目前中止選項
傳回
Promise<void>
timeInMs 之後已解決的承諾
deserializationPolicy(DeserializationContentTypes, SerializerOptions)
建立新的序列化 RequestPolicyCreator，以在 HTTP 管線傳遞時將 HTTP 要求主體序列化。
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory參數
- deserializationContentTypes
- DeserializationContentTypes
- parsingOptions
- SerializerOptions
傳回
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)
假設有一組要剖析為 JSON 或 XML 的特定內容類型，會取用 HTTP 回應來產生要求 OperationSpec所定義的結果物件。
function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse, options?: SerializerOptions): Promise<HttpOperationResponse>參數
- jsonContentTypes
-
string[]
將本文剖析為 JSON 的回應內容類型。
- xmlContentTypes
-
string[]
將本文剖析為 XML 的回應內容類型。
- response
- HttpOperationResponse
來自管線的 HTTP 回應。
- options
- SerializerOptions
序列化程式的選項，大部分用於視需要設定 XML 剖析器。
傳回
Promise<HttpOperationResponse>
可由ServiceClient傳回的已剖析HttpOperationResponse物件。
disableResponseDecompressionPolicy()
傳回可用來建立 實例 <xref:DisableResponseDecompressionPolicy> 的要求原則處理站。
function disableResponseDecompressionPolicy(): RequestPolicyFactory傳回
encodeUri(string)
編碼 URI。
function encodeUri(uri: string): string參數
- uri
-
string
要編碼的 URI。
傳回
string
編碼的 URI。
executePromisesSequentially(any[], unknown)
循序執行承諾陣列。 此方法的靈感如下： https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html 。 一個絕佳的承諾部落格！
function executePromisesSequentially(promiseFactories: any[], kickstart: unknown): Promise<any>參數
- promiseFactories
-
any[]
promise Factory 的陣列 (傳回 promise 的函式)
- kickstart
-
unknown
輸入用來啟動承諾鏈結的第一個承諾。 如果未提供，則承諾鏈結會以未定義開頭。
傳回
Promise<any>
已解決或拒絕的承諾鏈結
exponentialRetryPolicy(number, number, number)
只要指定的重試時間間隔上限，就會重試要求次數上限的原則，每次重試等候的時間超過上次的時間。
function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory參數
- retryCount
-
number
最大重試數目。
- retryInterval
-
number
重試之間的基底時間。
- maxRetryInterval
-
number
重試之間的等候時間上限。
傳回
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
將 HttpOperationResponse 剖析為正規化的 HTTP 回應物件， (RestResponse) 。
function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse參數
- _response
- HttpOperationResponse
HTTP 回應的包裝函式物件。
- responseSpec
-
undefined | OperationResponse
如何剖析回應屬性的對應器。
傳回
- 標準化回應物件。
generateClientRequestIdPolicy(string)
建立原則，將唯一要求識別碼指派給傳出要求。
function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory參數
- requestIdHeaderName
-
string
將唯一識別碼指派給要求時所要使用的標頭名稱。
傳回
generateUuid()
產生的 UUID
function generateUuid(): string傳回
string
RFC4122 v4 UUID。
getDefaultProxySettings(string)
將 Proxy 伺服器的指定 URL 轉換成 ProxySettings ，或在未傳遞 Proxy 伺服器時嘗試從目前環境擷取 ProxySettings 。
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined參數
- proxyUrl
-
string
Proxy 的 URL
傳回
ProxySettings | undefined
預設 Proxy 設定或未定義。
getDefaultUserAgentValue()
產生使用者代理程式的預設方法。 使用此套件的靜態資訊，以及執行時間中可用的系統資訊。
function getDefaultUserAgentValue(): string傳回
string
isDuration(string)
指出指定的字串是否為 ISO 8601 格式。
function isDuration(value: string): boolean參數
- value
-
string
要驗證 ISO 8601 持續時間格式的值。
傳回
boolean
true 如果有效，則為 ， false 否則為 。
isTokenCredential(unknown)
測試物件，以判斷它是否實作 TokenCredential。
function isTokenCredential(credential: unknown): credential參數
- credential
-
unknown
要測試的假設 TokenCredential。
傳回
credential
isValidUuid(string)
將指定的 uuid 驗證為字串
function isValidUuid(uuid: string): boolean參數
- uuid
-
string
uuid 作為需要驗證的字串
傳回
boolean
如果 uuid 有效，則為 True;否則為 false。
keepAlivePolicy(KeepAliveOptions)
建立原則，控制未來要求是否維護 HTTP 連線。
function keepAlivePolicy(keepAliveOptions?: KeepAliveOptions): RequestPolicyFactory參數
- keepAliveOptions
- KeepAliveOptions
保持運作選項。 根據預設，會針對未來的要求維護 HTTP 連線。
傳回
的實例 <xref:KeepAlivePolicy>
logPolicy(LogPolicyOptions)
建立原則，以記錄傳出要求和傳入回應的相關資訊。
function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory參數
- loggingOptions
- LogPolicyOptions
記錄選項。
傳回
的實例 <xref:LogPolicy>
operationOptionsToRequestOptionsBase<T>(T)
將 OperationOptions 轉換為 RequestOptionsBase
function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase參數
- opts
-
T
要轉換成 RequestOptionsBase 的 OperationOptions 物件
傳回
parseXML(string, SerializerOptions)
將指定的 XML 字串轉換成 JSON
function parseXML(str: string, opts?: SerializerOptions): Promise<any>參數
- str
-
string
包含要剖析為 JSON 之 XML 內容的字串
- opts
- SerializerOptions
控管指定 xml 字串剖析的選項
傳回
Promise<any>
promiseToCallback(Promise<any>)
警告
此 API 現已淘汰。
generated code should instead depend on responseToBody
將 Promise 轉換為回呼。
function promiseToCallback(promise: Promise<any>): (cb: Function) => void參數
- promise
-
Promise<any>
要轉換成回呼的 Promise
傳回
(cb: Function) => void
接受回呼的函式 (cb: Function) => void
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)
將 Promise 轉換為服務回呼。
function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): (cb: ServiceCallback<T>) => void參數
- promise
-
Promise<HttpOperationResponse>
要轉換成服務回呼的 HttpOperationResponse 承諾
傳回
(cb: ServiceCallback<T>) => void
採用服務回呼的函式 (cb： ServiceCallback) ： void
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })
原則，允許將 Proxy 設定套用至所有要求。 如果未傳遞靜態設定，則會從HTTPS_PROXY或HTTP_PROXY環境變數擷取它們。
function proxyPolicy(proxySettings?: ProxySettings, options?: { customNoProxyList?: string[] }): RequestPolicyFactory參數
- proxySettings
- ProxySettings
ProxySettings 用於每個要求。
- options
-
{ customNoProxyList?: string[] }
例如，自訂NO_PROXY模式的其他設定
傳回
redirectPolicy(number)
建立重新導向原則，如果回應到達「位置」標頭，且狀態碼介於 300 到 307 之間，則會將要求重複傳送至新的目的地。
function redirectPolicy(maximumRetries?: number): RequestPolicyFactory參數
- maximumRetries
-
number
要遵循的重新導向數目上限。
傳回
的實例 <xref:RedirectPolicy>
serializeObject(unknown)
公用程式函式，可將可能包含二進位資訊的物件序列化為純文字物件、陣列或字串。
function serializeObject(toSerialize: unknown): any參數
- toSerialize
-
unknown
傳回
any
signingPolicy(ServiceClientCredentials)
建立原則，藉由呼叫提供的 authenticationProvidersignRequest 方法來簽署傳出要求。
function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory參數
- authenticationProvider
- ServiceClientCredentials
驗證提供者。
傳回
<xref:SigningPolicy>的執行個體。
stringifyXML(unknown, SerializerOptions)
將指定的 JSON 物件轉換為 XML 字串
function stringifyXML(obj: unknown, opts?: SerializerOptions): string參數
- obj
-
unknown
要轉換成 XML 字串的 JSON 物件
- opts
- SerializerOptions
控制指定 JSON 物件的剖析選項
傳回
string
stripRequest(WebResourceLike)
傳回不包含授權標頭之 Http 要求的等量版本。
function stripRequest(request: WebResourceLike): WebResourceLike參數
- request
- WebResourceLike
Http Request 物件
傳回
已移除的 Http 要求版本。
stripResponse(HttpOperationResponse)
傳回只包含本文、標頭和狀態的 Http 回應等量版本。
function stripResponse(response: HttpOperationResponse): any參數
- response
- HttpOperationResponse
Http 回應
傳回
any
Http 回應的等量版本。
systemErrorRetryPolicy(number, number, number, number)
發生系統錯誤時重試的原則，由代碼 「ETIMEDOUT」、「ESOCKETTIMEDOUT」、「ECONNREFUSED」、「ECONNRESET」 或 「ENOENT」 識別。
function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory參數
- retryCount
-
number
最大重試數目。
- retryInterval
-
number
用戶端重試間隔，以毫秒為單位。
- minRetryInterval
-
number
最小重試間隔，以毫秒為單位。
- maxRetryInterval
-
number
重試間隔上限，以毫秒為單位。
傳回
的實例 <xref:SystemErrorRetryPolicy>
throttlingRetryPolicy()
如果回應指出要求因為節流原因而失敗，請建立重新傳送要求的原則。
例如，如果回應包含 Retry-After 標頭，它會根據該標頭的值重試傳送要求。
若要深入瞭解，請參閱 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(): RequestPolicyFactory傳回
tracingPolicy(TracingPolicyOptions)
建立一個原則，此原則會包裝具有追蹤範圍的傳出要求。
function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory參數
- tracingOptions
- TracingPolicyOptions
追蹤選項。
傳回
<xref:TracingPolicy> 類別的執行個體。
userAgentPolicy(TelemetryInfo)
傳回原則，根據指定的 TelemetryInfo，將使用者代理程式標頭新增至傳出要求。
function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory參數
- userAgentData
- TelemetryInfo
遙測資訊。
傳回
新的 <xref:UserAgentPolicy>。