你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure-rest/core-client package

接口

AddCredentialPipelinePolicyOptions	用于将凭据策略添加到管道的可选参数。
AdditionalPolicyConfig	用于配置在构造时添加到管道的其他策略。
Client	Rest 级别客户端的形状
ErrorModel	错误对象。
ErrorResponse	包含错误详细信息的响应。
FullOperationResponse	http 请求和响应的包装器对象。 当以 JSON 格式收到响应正文时，反序列化对象存储在 parsedBody 属性中。
InnerError	包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
OperationOptions	所有操作的基选项类型。
OperationRequestOptions	创建和发送此操作的 HTTP 请求时使用的选项。
ResourceMethods	定义可以对资源调用的方法

类型别名

ClientOptions	Rest 级别客户端可以采用的常规选项
HttpBrowserStreamResponse	Http 响应哪个正文是 NodeJS 流对象
HttpNodeStreamResponse	Http 响应哪个正文是 NodeJS 流对象
HttpResponse	表示 HttpResponse 的形状
PathParameters	用于检测路径模板文本中被包围 {} 的参数的帮助程序类型将被视为路径参数
PathUnchecked	定义 pathUnchecked 的签名。
PathUncheckedResponse	类型与 pathUnchecked 一起使用，将正文类型重写为 any 以允许灵活性
RawResponseCallback	在执行请求的操作时，每次从服务器收到响应时要调用的函数。 可以多次调用。
RequestParameters	默认请求参数的形状，这可能被特定请求类型替代以提供强类型
StreamableMethod	定义支持将响应正文作为原始流获取的方法的类型

函数

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)	如果提供了凭据，则向管道添加凭据策略。 如果未提供任何策略，则不添加任何策略。
createRestError(PathUncheckedResponse)	从 PathUnchecked 响应创建 rest 错误
createRestError(string, PathUncheckedResponse)	根据错误消息和 PathUnchecked 响应创建 rest 错误
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 响应创建 rest 错误

function createRestError(response: PathUncheckedResponse): RestError

参数

response

PathUncheckedResponse

返回

RestError

createRestError(string, PathUncheckedResponse)

根据错误消息和 PathUnchecked 响应创建 rest 错误

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 中的转换结果