你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
OperationSpec interface
定义操作的规范。
属性
base |
服务规范中提供的 URL。 这仍将包含所有 URL 模板变量。 如果在创建 OperationSpec 时未提供此项,则 ServiceClient 上的“baseUri”属性将填充它。 |
content |
请求正文的内容类型。 此值将用作“Content-Type”标头(如果提供)。 |
form |
操作方法的参数,将用于为操作的 HTTP 请求创建 formdata 正文。 |
header |
操作方法的参数,这些参数将转换为操作的 HTTP 请求上的标头。 |
http |
请求执行此操作时应使用的 HTTP 方法。 |
isXML | 此操作是否使用 XML 请求和响应正文。 |
media |
请求正文的媒体类型。 如果提供了此值,则可用于序列化中的助手。 |
path | 此操作 URL 的固定路径。 这仍将包含所有 URL 模板变量。 |
query |
将添加到构造 URL 的查询的操作方法的参数。 |
request |
将用于构造 HTTP 请求正文的参数。 |
responses | 此操作可以根据返回的状态代码返回不同类型的响应。 |
serializer | 要在此操作中使用的序列化程序。 |
url |
操作方法的参数,这些参数将替换为构造的 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
isXML
此操作是否使用 XML 请求和响应正文。
isXML?: boolean
属性值
boolean
mediaType
请求正文的媒体类型。 如果提供了此值,则可用于序列化中的助手。
mediaType?: string
属性值
string
path
此操作 URL 的固定路径。 这仍将包含所有 URL 模板变量。
path?: string
属性值
string
queryParameters
将添加到构造 URL 的查询的操作方法的参数。
queryParameters?: readonly OperationQueryParameter[]
属性值
readonly OperationQueryParameter[]
requestBody
responses
此操作可以根据返回的状态代码返回不同类型的响应。
responses: {[responseCode: string]: OperationResponseMap}
属性值
{[responseCode: string]: OperationResponseMap}
serializer
urlParameters
操作方法的参数,这些参数将替换为构造的 URL。
urlParameters?: readonly OperationURLParameter[]
属性值
readonly OperationURLParameter[]