@azure/ms-rest-js package
類別
| ApiKeyCredentials |
使用 API 金鑰向服務進行驗證。 |
| AzureIdentityCredentialAdapter |
這個類別提供簡單的擴充功能，以使用來自 <xref:TokenCredential> 連結庫的 |
| BaseRequestPolicy | |
| BasicAuthenticationCredentials | |
| DefaultHttpClient | |
| DomainCredentials |
使用 API 金鑰向服務進行驗證。 |
| HttpHeaders |
HTTP 標頭索引鍵/值組的集合。 |
| RequestPolicyOptions |
建立 RequestPolicy 時可以使用的選擇性屬性。 |
| RestError | |
| Serializer | |
| ServiceClient | |
| TokenCredentials |
使用令牌字串和撰寫配置進行驗證的認證物件。 |
| TopicCredentials |
使用 API 金鑰向服務進行驗證。 |
| URLBuilder |
處理建立、修改和剖析 URL 的類別。 |
| URLQuery |
處理 URLBuilder 查詢部分的類別。 |
| WebResource |
建立新的 WebResource 物件。 這個類別藉由成為連結庫/實作無關，並包裝必要的屬性來起始要求，以提供 REST 呼叫的抽象概念。 |
介面
| AbortSignalLike |
允許在引發「中止」事件時中止要求。 與瀏覽器內建 AbortSignal 和一般 polyfills 相容。 |
| AgentSettings |
HTTP 和 HTTPS 代理程式 （僅限Node.js） |
| ApiKeyCredentialOptions | |
| BaseMapper | |
| CompositeMapper | |
| CompositeMapperType | |
| DeserializationContentTypes |
表示作業回應應以特定方式還原串行化的內容類型。 |
| DictionaryMapper | |
| DictionaryMapperType | |
| EnumMapper | |
| EnumMapperType | |
| HttpClient |
可傳送 HttpRequests 並接收已承諾 HttpResponses 的介面。 |
| HttpHeader |
HttpHeaders 集合中的個別標頭。 |
| HttpHeadersLike |
HTTP 標頭索引鍵/值組的集合。 |
| HttpOperationResponse |
HTTP 要求和回應的包裝函式物件。 當響應主體以 JSON 或 XML 接收時，還原串行化物件會儲存在 |
| HttpPipelineLogger |
可新增至 HttpPipeline 的記錄器。 這可讓每個 RequestPolicy 記錄可用於偵錯的訊息。 |
| HttpResponse |
HTTP 回應上的屬性，一律會出現。 |
| MapperConstraints | |
| OperationArguments |
套用至作業單一調用的屬性集合。 |
| OperationParameter |
所有 Operation 參數擴充的通用介面。 |
| OperationQueryParameter |
將做為查詢參數加入至作業 HTTP 要求之作業的參數。 |
| OperationResponse |
可從單一狀態代碼的作業要求傳回的 OperationResponse。 |
| OperationSpec |
定義作業的規格。 |
| OperationURLParameter |
將取代為作業要求 URL 之作業的參數。 |
| ParameterValue |
RequestPrepareOptions 中路徑或查詢參數所提供的 Parameter 值 |
| PolymorphicDiscriminator | |
| ProxySettings |
HTTP Proxy 設定 （僅限Node.js） |
| RedirectOptions |
如何處理重新導向響應的選項。 |
| RequestOptionsBase |
描述將用於每個作業之 options 物件的基底結構。 |
| RequestPolicy | |
| RequestPolicyOptionsLike |
建立 RequestPolicy 時可以使用的選擇性屬性。 |
| RequestPrepareOptions | |
| RestResponse |
REST 呼叫的扁平化回應。 包含基礎 HttpOperationResponse，以及 parsedBody、parsedHeaders 等的合併屬性。 |
| SequenceMapper | |
| SequenceMapperType | |
| ServiceCallback | |
| ServiceClientCredentials | |
| ServiceClientOptions |
建立用戶端時要提供的選項。 |
| SimpleMapperType | |
| TokenResponse |
TokenResponse 定義於 |
| UrlParameterValue | |
| WebResourceLike |
REST 呼叫的抽象概念。 |
類型別名
| Authenticator | |
| CommonRequestInfo | |
| CommonRequestInit | |
| CommonResponse | |
| HttpMethods | |
| HttpRequestBody | |
| Mapper | |
| MapperType | |
| ParameterPath | |
| RawHttpHeaders |
以簡單 JSON 物件表示的 HttpHeaders 集合。 |
| RequestPolicyFactory |
建立使用所提供 nextPolicy 之每個要求的新 RequestPolicy。 |
| TelemetryInfo | |
| TransferProgressEvent |
引發以回應上傳或下載進度。 |
列舉
| HttpPipelineLogLevel |
可用於 HttpPipelineLogger 的不同記錄層級。 |
| QueryCollectionFormat |
將用來聯結值陣列以取得查詢參數值的格式。 |
函式
函式詳細資料
agentPolicy(AgentSettings)
function agentPolicy(agentSettings?: AgentSettings): RequestPolicyFactory參數
- agentSettings
- AgentSettings
傳回
applyMixins(any, any[])
將 sourceCtors 原型上的屬性套用至 targetCtor 的原型
function applyMixins(targetCtor: any, sourceCtors: any[])參數
- targetCtor
-
any
需要套用屬性的目標物件。
- sourceCtors
-
any[]
來源對象的陣列，需要從中擷取屬性。
delay<T>(number, T)
setTimeout 的包裝函式，會在 t 毫秒之後解析承諾。
function delay<T>(t: number, value?: T): Promise<T>參數
- t
-
number
要延遲的毫秒數。
- value
-
T
在 t 毫秒逾時之後要解析的值。
傳回
Promise<T>
已解決的承諾
deserializationPolicy(DeserializationContentTypes)
建立新的串行化 RequestPolicyCreator，以在 HTTP 管線通過時串行化 HTTP 要求主體。
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes): RequestPolicyFactory參數
- deserializationContentTypes
- DeserializationContentTypes
傳回
deserializeResponseBody(string[], string[], HttpOperationResponse)
function deserializeResponseBody(jsonContentTypes: string[], xmlContentTypes: string[], response: HttpOperationResponse): Promise<HttpOperationResponse>參數
- jsonContentTypes
-
string[]
- xmlContentTypes
-
string[]
- response
- HttpOperationResponse
傳回
Promise<HttpOperationResponse>
encodeUri(string)
編碼 URI。
function encodeUri(uri: string): string參數
- uri
-
string
要編碼的 URI。
傳回
string
編碼的 URI。
executePromisesSequentially(any[], any)
循序執行承諾陣列。 此方法的靈感在這裡：https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html。 關於承諾的真棒部落格！
function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>參數
- promiseFactories
-
any[]
Promise Factory 陣列（傳回 Promise 的函式）
- kickstart
-
any
輸入用來啟動承諾鏈結的第一個承諾。 如果未提供，則承諾鏈結會以未定義開頭。
傳回
Promise<any>
已解決或拒絕的承諾鏈結
exponentialRetryPolicy(number, number, number, number)
function exponentialRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory參數
- retryCount
-
number
- retryInterval
-
number
- minRetryInterval
-
number
- maxRetryInterval
-
number
傳回
flattenResponse(HttpOperationResponse, undefined | OperationResponse)
function flattenResponse(_response: HttpOperationResponse, responseSpec: undefined | OperationResponse): RestResponse參數
- _response
- HttpOperationResponse
- responseSpec
-
undefined | OperationResponse
傳回
generateClientRequestIdPolicy(string)
function generateClientRequestIdPolicy(requestIdHeaderName?: string): RequestPolicyFactory參數
- requestIdHeaderName
-
string
傳回
generateUuid()
產生的 UUID
function generateUuid(): string傳回
string
RFC4122 v4 UUID。
getDefaultProxySettings(string)
function getDefaultProxySettings(proxyUrl?: string): ProxySettings | undefined參數
- proxyUrl
-
string
傳回
ProxySettings | undefined
getDefaultUserAgentValue()
function getDefaultUserAgentValue(): string傳回
string
isDuration(string)
指出指定的字串是否為 ISO 8601 格式。
function isDuration(value: string): boolean參數
- value
-
string
要針對 ISO 8601 持續時間格式驗證的值。
傳回
boolean
如果有效，true 否則為 false。
isValidUuid(string)
將指定的 uuid 驗證為字串
function isValidUuid(uuid: string): boolean參數
- uuid
-
string
uuid 作為需要驗證的字串
傳回
boolean
如果 uuid 有效，則為 True;否則為 false。
logPolicy(any)
promiseToCallback(Promise<any>)
警告
此 API 現已淘汰。
generated code should instead depend on responseToBody
將 Promise 轉換為回呼。
function promiseToCallback(promise: Promise<any>): Function參數
- promise
-
Promise<any>
要轉換成回呼的 Promise
傳回
Function
採用回呼的函式 （cb： Function）： void
promiseToServiceCallback<T>(Promise<HttpOperationResponse>)
將 Promise 轉換為服務回呼。
function promiseToServiceCallback<T>(promise: Promise<HttpOperationResponse>): Function參數
- promise
-
Promise<HttpOperationResponse>
要轉換成服務回呼的 HttpOperationResponse Promise
傳回
Function
接受服務回調的函數（cb：ServiceCallback<T>）：void
proxyPolicy(ProxySettings)
function proxyPolicy(proxySettings?: ProxySettings): RequestPolicyFactory參數
- proxySettings
- ProxySettings
傳回
redirectPolicy(number)
function redirectPolicy(maximumRetries?: number): RequestPolicyFactory參數
- maximumRetries
-
number
傳回
serializeObject(any)
function serializeObject(toSerialize: any): any參數
- toSerialize
-
any
傳回
any
signingPolicy(ServiceClientCredentials)
function signingPolicy(authenticationProvider: ServiceClientCredentials): RequestPolicyFactory參數
- authenticationProvider
- ServiceClientCredentials
傳回
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)
function systemErrorRetryPolicy(retryCount?: number, retryInterval?: number, minRetryInterval?: number, maxRetryInterval?: number): RequestPolicyFactory參數
- retryCount
-
number
- retryInterval
-
number
- minRetryInterval
-
number
- maxRetryInterval
-
number
傳回
throttlingRetryPolicy(number)
function throttlingRetryPolicy(maxRetries?: number): RequestPolicyFactory參數
- maxRetries
-
number
傳回
userAgentPolicy(TelemetryInfo)
function userAgentPolicy(userAgentData?: TelemetryInfo): RequestPolicyFactory參數
- userAgentData
- TelemetryInfo