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[]