@azure/core-http package

類別

AccessTokenRefresher	如果我們目前未等候新的令牌，可協助 core-http 令牌驗證原則要求新的令牌。
ApiKeyCredentials	使用 API 金鑰向服務進行驗證。
BaseRequestPolicy	所有要求原則衍生自的基類。
BasicAuthenticationCredentials	使用使用者名稱和密碼進行驗證的簡單 <xref:ServiceClientCredential>。
DefaultHttpClient	使用 node-fetch的 HTTP 用戶端。
ExpiringAccessTokenCache	提供 AccessTokenCache 實作，以清除已快取 AccessToken到期後已通過的 AccessToken。
HttpHeaders	HTTP 標頭索引鍵/值組的集合。
RequestPolicyOptions	建立 RequestPolicy 時可以使用的選擇性屬性。
RestError	從 HTTP 要求到服務端點所造成的錯誤。
Serializer	用來將原始回應對象對應至最終圖形。 協助封裝和解壓縮日期和其他不是 JSON 內建的編碼類型。 也允許從標頭提取值，以及插入預設值和常數。
ServiceClient	ServiceClient 會傳送服務要求並接收回應。
TopicCredentials	用於 Azure 事件方格的 TopicCredentials 物件。
URLBuilder	處理建立、修改和剖析 URL 的類別。
URLQuery	處理 URLBuilder 查詢部分的類別。
WebResource	建立新的 WebResource 物件。 這個類別藉由成為連結庫/實作無關，並包裝必要的屬性來起始要求，以提供 REST 呼叫的抽象概念。

介面

AbortSignalLike	允許在引發「中止」事件時中止要求。 與瀏覽器內建 AbortSignal 和一般 polyfills 相容。
AccessToken	表示到期時間的存取令牌。
AccessTokenCache	提供從 TokenCredential 傳回之 AccessToken 的快取。
ApiKeyCredentialOptions	描述建立 ApiKeyCredentials 實例時要提供的選項
BaseMapper	對應工具的基底定義。 可用於 XML 和純 JavaScript 物件。
CompositeMapper	由其他對應器組成的對應程式。
CompositeMapperType	協助建置對應程式，描述如何根據其他對應器對應物件的一組屬性。 應該只有下列其中一個屬性：className、modelProperties 和 additionalProperties。
DeserializationContentTypes	表示作業回應應以特定方式還原串行化的內容類型。
DeserializationOptions	設定 API 回應還原串行化的選項。
DictionaryMapper	描述做為索引鍵/值組之一般 JavaScript 物件的對應程式。
DictionaryMapperType	協助建置對應程式，描述如何剖析對應值的字典。
EnumMapper	描述列舉值的對應程式。
EnumMapperType	協助建置描述如何剖析列舉值的對應程式。
GetTokenOptions	定義 TokenCredential.getToken 的選項。
HttpClient	可傳送 HttpRequests 並接收已承諾 HttpResponses 的介面。
HttpHeader	HttpHeaders 集合中的個別標頭。
HttpHeadersLike	HTTP 標頭索引鍵/值組的集合。
HttpOperationResponse	HTTP 要求和回應的包裝函式物件。 當響應主體以 JSON 或 XML 接收時，還原串行化物件會儲存在 parsedBody 屬性中。
HttpPipelineLogger	可新增至 HttpPipeline 的記錄器。 這可讓每個 RequestPolicy 記錄可用於偵錯的訊息。
HttpResponse	HTTP 回應上的屬性，一律會出現。
InternalPipelineOptions	定義用來為 SDK 用戶端設定 HTTP 管線內部選項的選項。
KeepAliveOptions	應針對未來要求維護 HTTP 連線的選項。
LogPolicyOptions	傳遞至 logPolicy選項。 根據預設，只會記錄一組標頭清單，不過這可以設定。 永遠不會記錄要求和響應主體。
MapperConstraints	各種值條件約束的描述，例如整數範圍和字串 regex。
OperationArguments	套用至作業單一調用的屬性集合。
OperationOptions	所有作業的基底選項類型。
OperationParameter	所有 Operation 參數擴充的通用介面。
OperationQueryParameter	將做為查詢參數加入至作業 HTTP 要求之作業的參數。
OperationRequestOptions	允許設定 SDK 作業所提出 HTTP 要求處理的選項。
OperationResponse	可從單一狀態代碼的作業要求傳回的 OperationResponse。
OperationSpec	定義如何透過 HTTP 執行特定服務作業的規格，包括如何將要求資訊正確串行化，並將響應資訊還原串行化為 ServiceClient所傳回的物件承載。
OperationURLParameter	將取代為作業要求 URL 之作業的參數。
ParameterValue	RequestPrepareOptions 中路徑或查詢參數所提供的 Parameter 值
PipelineOptions	定義用來設定 SDK 用戶端 HTTP 管線的選項。
PolymorphicDiscriminator	用來釐清區分型別等位。 例如，如果回應可以有許多圖形，但也包含 『kind』 字段 （或類似的），則可以使用該字段來判斷如何將回應還原串行化為正確的類型。
ProxySettings	為傳出要求設定 Proxy 的選項（僅限Node.js）。
RedirectOptions	如何處理重新導向響應的選項。
RequestOptionsBase	描述將用於每個作業之 options 物件的基底結構。
RequestPolicy	要求原則的基礎結構。
RequestPolicyOptionsLike	建立 RequestPolicy 時可以使用的選擇性屬性。
RequestPrepareOptions	準備連出 HTTP 要求的選項。
RestResponse	REST 呼叫的扁平化回應。 包含基礎 HttpOperationResponse，以及 parsedBody、parsedHeaders等的合併屬性。
RetryOptions	控制如何重試失敗要求的選項。
SequenceMapper	描述陣列的對應程式。
SequenceMapperType	協助建置描述如何剖析對應值序列的對應程式。
SerializerOptions	管理 xml 剖析器和產生器行為的選項。
ServiceCallback
ServiceClientCredentials	表示具有 signRequest 方法的對象或類別，這個方法會簽署傳出要求（例如，藉由設定 Authorization 標頭）。
ServiceClientOptions	建立用戶端時要提供的選項。
SimpleMapperType	簡單對應工具的類型。
TokenCredential	表示能夠提供驗證令牌的認證。
TracingPolicyOptions	自訂追蹤原則的選項。
UrlParameterValue	表示 URL 參數值的介面。
UserAgentOptions	將使用者代理程式詳細數據新增至傳出要求的選項。
WebResourceLike	要對遠端伺服器提出 HTTP 要求的描述。

類型別名

Authenticator	接收挑戰並解決具有字串令牌之承諾的函式。
CommonRequestInfo	呼叫 至 fetch()時所使用的字串 URL。
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 的原型
bearerTokenAuthenticationPolicy(TokenCredential, string | string[])	為 RequestPolicy 建立新的處理站，以將持有人令牌套用至要求的 Authorization 標頭。
createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)	根據指定的選項建立 HTTP 管線。
delay(number, DelayOptions)	setTimeout 的包裝函式，會在 timeInMs 毫秒之後解析承諾。
deserializationPolicy(DeserializationContentTypes, SerializerOptions)	建立新的串行化 RequestPolicyCreator，以在 HTTP 管線通過時串行化 HTTP 要求主體。
deserializeResponseBody(string[], string[], HttpOperationResponse, SerializerOptions)	給定要剖析為 JSON 或 XML 的特定內容類型集，會取用 HTTP 回應來產生要求 OperationSpec所定義的結果物件。
disableResponseDecompressionPolicy()	傳回可用來建立 <xref:DisableResponseDecompressionPolicy>實例的要求原則處理站。
encodeUri(string)	編碼 URI。
executePromisesSequentially(any[], unknown)	循序執行承諾陣列。 此方法的靈感在這裡：https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html。 關於承諾的真棒部落格！
exponentialRetryPolicy(number, number, number)	只要指定的重試時間間隔上限，重試要求的時間上限，每次重試等候的時間比上次還要長的原則。
flattenResponse(HttpOperationResponse, undefined | OperationResponse)	將 HttpOperationResponse 剖析為標準化 HTTP 回應物件（RestResponse）。
generateClientRequestIdPolicy(string)	建立將唯一要求標識碼指派給傳出要求的原則。
generateUuid()	產生的 UUID
getDefaultProxySettings(string)	將 Proxy 伺服器的指定 URL 轉換成 ProxySettings，或嘗試在未傳遞 ProxySettings 時，從目前環境擷取 ProxySettings。
getDefaultUserAgentValue()	產生使用者代理程序的預設方法。 使用此套件中的靜態資訊，以及運行時間可用的系統資訊。
isDuration(string)	指出指定的字串是否為 ISO 8601 格式。
isTokenCredential(unknown)	測試 物件，以判斷它是否實作 TokenCredential。
isValidUuid(string)	將指定的 uuid 驗證為字串
keepAlivePolicy(KeepAliveOptions)	建立原則，控制未來要求是否維護 HTTP 連線。
logPolicy(LogPolicyOptions)	建立原則，以記錄傳出要求和傳入回應的相關信息。
operationOptionsToRequestOptionsBase<T>(T)	將 OperationOptions 轉換為 RequestOptionsBase
parseXML(string, SerializerOptions)	將指定的 XML 字串轉換成 JSON
promiseToCallback(Promise<any>)	將 Promise 轉換為回呼。
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)	將 Promise 轉換為服務回呼。
proxyPolicy(ProxySettings, { customNoProxyList?: string[] })	允許將 Proxy 設定套用至所有要求的原則。 如果未傳遞靜態設定，則會從HTTPS_PROXY或HTTP_PROXY環境變數擷取它們。
redirectPolicy(number)	建立重新導向原則，如果回應送達「位置」標頭，且狀態代碼介於 300 到 307 之間，則會將要求重複傳送至新的目的地。
serializeObject(unknown)	公用程式函式，可將可能包含二進位資訊的物件串行化成一般對象、數位或字串。
signingPolicy(ServiceClientCredentials)	建立原則，以呼叫提供的 authenticationProvider的 signRequest 方法，以簽署傳出要求。
stringifyXML(unknown, SerializerOptions)	將指定的 JSON 物件轉換為 XML 字串
stripRequest(WebResourceLike)	傳回不包含授權標頭之 Http 要求的等量版本。
stripResponse(HttpOperationResponse)	傳回只包含本文、標頭和狀態之 Http 回應的等量版本。
systemErrorRetryPolicy(number, number, number, number)	發生系統錯誤時重試的原則，由代碼 「ETIMEDOUT」、“ESOCKETTIMEDOUT”、“ECONNREFUSED”、“ECONNRESET” 或 “ENOENT” 所識別。
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
tracingPolicy(TracingPolicyOptions)	建立一個原則，以追蹤範圍包裝傳出要求。
userAgentPolicy(TelemetryInfo)	傳回原則，根據指定的 TelemetryInfo，將使用者代理程式標頭新增至傳出要求。

函式詳細資料

applyMixins(unknown, any[])

將 sourceCtors 原型上的屬性套用至 targetCtor 的原型

function applyMixins(targetCtorParam: unknown, sourceCtors: any[])

參數

targetCtorParam

unknown

sourceCtors

any[]

來源對象的陣列，需要從中擷取屬性。

bearerTokenAuthenticationPolicy(TokenCredential, string | string[])

為 RequestPolicy 建立新的處理站，以將持有人令牌套用至要求的 Authorization 標頭。

function bearerTokenAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory

參數

credential

TokenCredential

可提供持有人令牌的 TokenCredential 實作。

scopes

string | string[]

持有人令牌套用的範圍。

傳回

RequestPolicyFactory

createPipelineFromOptions(InternalPipelineOptions, RequestPolicyFactory)

根據指定的選項建立 HTTP 管線。

function createPipelineFromOptions(pipelineOptions: InternalPipelineOptions, authPolicyFactory?: RequestPolicyFactory): ServiceClientOptions

參數

pipelineOptions

InternalPipelineOptions

定義用來在 SDK 用戶端的 HTTP 管線中設定原則的選項。

authPolicyFactory

RequestPolicyFactory

用於簽署要求的選擇性驗證原則處理站。

傳回

ServiceClientOptions

可傳遞一組選項，以建立新的 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

傳回

RequestPolicyFactory

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>

剖析 HttpOperationResponse 物件，可由 ServiceClient傳回。

disableResponseDecompressionPolicy()

傳回可用來建立 <xref:DisableResponseDecompressionPolicy>實例的要求原則處理站。

function disableResponseDecompressionPolicy(): RequestPolicyFactory

傳回

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

重試之間等候的時間上限。

傳回

RequestPolicyFactory

flattenResponse(HttpOperationResponse, undefined | OperationResponse)

將 HttpOperationResponse 剖析為標準化 HTTP 回應物件（RestResponse）。

function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse

參數

_response

HttpOperationResponse

HTTP 回應的包裝函式物件。

responseSpec

undefined | OperationResponse

如何剖析回應屬性的對應程式。

傳回

RestResponse

• 標準化回應物件。

generateClientRequestIdPolicy(string)

建立將唯一要求標識碼指派給傳出要求的原則。

function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory

參數

requestIdHeaderName

string

將唯一標識碼指派給要求時要使用的標頭名稱。

傳回

RequestPolicyFactory

generateUuid()

產生的 UUID

function generateUuid(): string

傳回

string

RFC4122 v4 UUID。

getDefaultProxySettings(string)

將 Proxy 伺服器的指定 URL 轉換成 ProxySettings，或嘗試在未傳遞 ProxySettings 時，從目前環境擷取 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 聯機會針對未來的要求進行維護。

傳回

RequestPolicyFactory

<xref:KeepAlivePolicy> 的實例

logPolicy(LogPolicyOptions)

建立原則，以記錄傳出要求和傳入回應的相關信息。

function logPolicy(loggingOptions?: LogPolicyOptions): RequestPolicyFactory

參數

loggingOptions

LogPolicyOptions

記錄選項。

傳回

RequestPolicyFactory

<xref:LogPolicy> 的實例

operationOptionsToRequestOptionsBase<T>(T)

將 OperationOptions 轉換為 RequestOptionsBase

function operationOptionsToRequestOptionsBase<T>(opts: T): RequestOptionsBase

參數

opts

T

要轉換成 RequestOptionsBase 的 OperationOptions 物件

傳回

RequestOptionsBase

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 Promise

傳回

(cb: ServiceCallback<T>) => void

接受服務回調的函數（cb：ServiceCallback<T>）：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模式

傳回

RequestPolicyFactory

redirectPolicy(number)

建立重新導向原則，如果回應送達「位置」標頭，且狀態代碼介於 300 到 307 之間，則會將要求重複傳送至新的目的地。

function redirectPolicy(maximumRetries?: number): RequestPolicyFactory

參數

maximumRetries

number

要追蹤的重新導向數目上限。

傳回

RequestPolicyFactory

<xref:RedirectPolicy> 的實例

serializeObject(unknown)

公用程式函式，可將可能包含二進位資訊的物件串行化成一般對象、數位或字串。

function serializeObject(toSerialize: unknown): any

參數

toSerialize

unknown

傳回

any

signingPolicy(ServiceClientCredentials)

建立原則，以呼叫提供的 authenticationProvider的 signRequest 方法，以簽署傳出要求。

function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory

參數

authenticationProvider

ServiceClientCredentials

驗證提供者。

傳回

RequestPolicyFactory

<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 物件

傳回

WebResourceLike

已移除的 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

重試間隔上限，以毫秒為單位。

傳回

RequestPolicyFactory

<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

傳回

RequestPolicyFactory

tracingPolicy(TracingPolicyOptions)

建立一個原則，以追蹤範圍包裝傳出要求。

function tracingPolicy(tracingOptions?: TracingPolicyOptions): RequestPolicyFactory

參數

tracingOptions

TracingPolicyOptions

追蹤選項。

傳回

RequestPolicyFactory

<xref:TracingPolicy> 類別的實例。

userAgentPolicy(TelemetryInfo)

傳回原則，根據指定的 TelemetryInfo，將使用者代理程式標頭新增至傳出要求。

function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory

參數

userAgentData

TelemetryInfo

遙測資訊。

傳回

RequestPolicyFactory

新的 <xref:UserAgentPolicy>。