@azure-rest/core-client package

介面

AddCredentialPipelinePolicyOptions	將認證原則新增至管線的選擇性參數。
AdditionalPolicyConfig	用來設定在建構時新增至管線的其他原則。
Client	Rest Level 用戶端的形狀
ErrorModel	error 物件。
ErrorResponse	包含錯誤詳細數據的回應。
FullOperationResponse	HTTP 要求和回應的包裝函式物件。 當回應本文以 JSON 接收時，還原串行化物件會儲存在 parsedBody 屬性中。
InnerError	物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
OperationOptions	所有作業的基底選項類型。
OperationRequestOptions	建立和傳送此作業之 HTTP 要求時所使用的選項。
ResourceMethods	定義可在資源上呼叫的方法

類型別名

ClientOptions	Rest Level Client 可以採用的一般選項
HttpBrowserStreamResponse	Http 回應，主體為 NodeJS 數據流物件
HttpNodeStreamResponse	Http 回應，主體為 NodeJS 數據流物件
HttpResponse	代表 HttpResponse 的形狀
PathParameters	用來偵測路徑範本文字中由 {} 括住之參數的協助程式類型會被視為路徑參數
PathUnchecked	定義 pathUnchecked 的簽章。
PathUncheckedResponse	要搭配 pathUnchecked 使用的型別，會將本文類型覆寫為任一類型，以允許彈性
RawResponseCallback	每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。 此回呼會以兩個參數呼叫：原始回應，包括標頭和回應本文;和錯誤物件，如果處理要求時擲回錯誤，則會提供這個物件。 第三個__legacyError參數僅供回溯相容性使用，且與 error 參數具有相同的值。
RequestParameters	默認要求參數的形狀，可能會由特定要求類型覆寫以提供強型別
StreamableMethod	定義方法的類型，這個方法支援取得回應本文做為原始數據流

函式

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)	如果提供認證，將認證原則新增至管線。 如果未提供任何原則，則不會新增任何原則。
createRestError(PathUncheckedResponse)	從 PathUnchecked 回應建立其餘錯誤
createRestError(string, PathUncheckedResponse)	從錯誤訊息和 PathUnchecked 回應建立其餘錯誤
getClient(string, ClientOptions)	使用預設管線建立用戶端
getClient(string, TokenCredential | KeyCredential, ClientOptions)	使用預設管線建立用戶端
operationOptionsToRequestParameters(OperationOptions)	將 OperationOptions 轉換為 RequestParameters 的協助程式函式

函式詳細資料

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

如果提供認證，將認證原則新增至管線。 如果未提供任何原則，則不會新增任何原則。

function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)

參數

pipeline

Pipeline

endpoint

string

options

AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

從 PathUnchecked 回應建立其餘錯誤

function createRestError(response: PathUncheckedResponse): RestError

參數

response

PathUncheckedResponse

傳回

RestError

createRestError(string, PathUncheckedResponse)

從錯誤訊息和 PathUnchecked 回應建立其餘錯誤

function createRestError(message: string, response: PathUncheckedResponse): RestError

參數

message

string

response

PathUncheckedResponse

傳回

RestError

getClient(string, ClientOptions)

使用預設管線建立用戶端

function getClient(endpoint: string, options?: ClientOptions): Client

參數

endpoint

string

用戶端的基底端點

options

ClientOptions

用戶端選項

傳回

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

使用預設管線建立用戶端

function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client

參數

endpoint

string

用戶端的基底端點

credentials

TokenCredential | KeyCredential

用來驗證要求的認證

options

ClientOptions

用戶端選項

傳回

Client

operationOptionsToRequestParameters(OperationOptions)

將 OperationOptions 轉換為 RequestParameters 的協助程式函式

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

參數

options

OperationOptions

模組化層用來傳送要求的選項

傳回

RequestParameters

RLC 層 RequestParameters 中的轉換結果