OperationSpec interface

パッケージ:

@azure/core-http

要求情報をに適切にシリアル化し、 ServiceClient によって返されるオブジェクト ペイロードに応答情報を逆シリアル化する方法など、HTTP 経由で特定のサービス操作を実行する方法を定義する仕様。

プロパティ

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