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

OperationSpec interface

包:: @azure/core-http

定义如何通过 HTTP 执行特定服务作的规范，包括如何将请求信息正确序列化为 ServiceClient可返回的对象有效负载，以及如何反序列化响应信息。

属性

baseUrl	服务规范中提供的 URL。这仍将包含其中的所有 URL 模板变量。如果在创建 OperationSpec 时未提供此项，则会由 ServiceClient 上的“baseUri”属性填充。
contentType	请求正文的内容类型。如果提供此值，该值将用作“Content-Type”标头。
formDataParameters	作方法的参数，将用于为作的 HTTP 请求创建 formdata 正文。
headerParameters	作方法的参数，这些参数将转换为作的 HTTP 请求上的标头。
httpMethod	请求应用于此作的 HTTP 方法。
isXML	此作是否使用 XML 请求和响应正文。
mediaType	请求正文的媒体类型。如果提供此值，则可用于序列化中的助手。
path	此作 URL 的固定路径。这仍将包含其中的所有 URL 模板变量。
queryParameters	要添加到构造 URL 查询的作方法的参数。
requestBody	将用于构造 HTTP 请求正文的参数。
responses	此作可以基于返回的状态代码返回的不同类型的响应。
serializer	在此作中使用的序列化程序。
urlParameters	将替换为构造 URL 的作方法的参数。

属性详细信息

baseUrl

服务规范中提供的 URL。这仍将包含其中的所有 URL 模板变量。如果在创建 OperationSpec 时未提供此项，则会由 ServiceClient 上的“baseUri”属性填充。

baseUrl?: string

属性值

string

contentType

请求正文的内容类型。如果提供此值，该值将用作“Content-Type”标头。

contentType?: string

属性值

string

formDataParameters

作方法的参数，将用于为作的 HTTP 请求创建 formdata 正文。

formDataParameters?: readonly OperationParameter[]

属性值

readonly OperationParameter[]

headerParameters

作方法的参数，这些参数将转换为作的 HTTP 请求上的标头。

headerParameters?: readonly OperationParameter[]

属性值

readonly OperationParameter[]

httpMethod

请求应用于此作的 HTTP 方法。

httpMethod: HttpMethods

属性值

HttpMethods

isXML

此作是否使用 XML 请求和响应正文。

isXML?: boolean

属性值

boolean

mediaType

请求正文的媒体类型。如果提供此值，则可用于序列化中的助手。

mediaType?: string

属性值

string

path

此作 URL 的固定路径。这仍将包含其中的所有 URL 模板变量。

path?: string

属性值

string

queryParameters

要添加到构造 URL 查询的作方法的参数。

queryParameters?: readonly OperationQueryParameter[]

属性值

readonly OperationQueryParameter[]

requestBody

将用于构造 HTTP 请求正文的参数。

requestBody?: OperationParameter

属性值

OperationParameter

responses

此作可以基于返回的状态代码返回的不同类型的响应。

responses: {[responseCode: string]: OperationResponse}

属性值

{[responseCode: string]: OperationResponse}

serializer

在此作中使用的序列化程序。

serializer: Serializer

属性值

Serializer

urlParameters

将替换为构造 URL 的作方法的参数。

urlParameters?: readonly OperationURLParameter[]

属性值

readonly OperationURLParameter[]