OperationSpec interface

Paket:

@azure/ms-rest-js

Spesifikasi yang mendefinisikan operasi.

Properti

baseUrl	URL yang disediakan dalam spesifikasi layanan. Ini masih akan memiliki semua variabel templat URL di dalamnya. Jika ini tidak disediakan ketika OperationSpec dibuat, maka itu akan diisi oleh properti "baseUri" pada ServiceClient.
contentType	Jenis konten isi permintaan. Nilai ini akan digunakan sebagai header "Content-Type" jika disediakan.
formDataParameters	Parameter ke metode operasi yang akan digunakan untuk membuat isi formdata untuk permintaan HTTP operasi.
headerParameters	Parameter ke metode operasi yang akan dikonversi ke header pada permintaan HTTP operasi.
httpMethod	Metode HTTP yang harus digunakan oleh permintaan untuk operasi ini.
isXML	Apakah operasi ini menggunakan badan permintaan dan respons XML atau tidak.
path	Jalur tetap untuk URL operasi ini. Ini masih akan memiliki semua variabel templat URL di dalamnya.
queryParameters	Parameter ke metode operasi yang akan ditambahkan ke kueri URL yang dibangun.
requestBody	Parameter yang akan digunakan untuk membangun isi permintaan HTTP.
responses	Berbagai jenis respons yang dapat dikembalikan operasi ini berdasarkan kode status apa yang dikembalikan.
serializer	Serializer yang digunakan dalam operasi ini.
urlParameters	Parameter ke metode operasi yang akan diganti ke dalam URL yang dibangun.

Detail Properti

baseUrl

URL yang disediakan dalam spesifikasi layanan. Ini masih akan memiliki semua variabel templat URL di dalamnya. Jika ini tidak disediakan ketika OperationSpec dibuat, maka itu akan diisi oleh properti "baseUri" pada ServiceClient.

baseUrl?: string

Nilai Properti

string

contentType

Jenis konten isi permintaan. Nilai ini akan digunakan sebagai header "Content-Type" jika disediakan.

contentType?: string

Nilai Properti

string

formDataParameters

Parameter ke metode operasi yang akan digunakan untuk membuat isi formdata untuk permintaan HTTP operasi.

formDataParameters?: readonly OperationParameter[]

Nilai Properti

readonly OperationParameter[]

headerParameters

Parameter ke metode operasi yang akan dikonversi ke header pada permintaan HTTP operasi.

headerParameters?: readonly OperationParameter[]

Nilai Properti

readonly OperationParameter[]

httpMethod

Metode HTTP yang harus digunakan oleh permintaan untuk operasi ini.

httpMethod: HttpMethods

Nilai Properti

HttpMethods

isXML

Apakah operasi ini menggunakan badan permintaan dan respons XML atau tidak.

isXML?: boolean

Nilai Properti

boolean

path

Jalur tetap untuk URL operasi ini. Ini masih akan memiliki semua variabel templat URL di dalamnya.

path?: string

Nilai Properti

string

queryParameters

Parameter ke metode operasi yang akan ditambahkan ke kueri URL yang dibangun.

queryParameters?: readonly OperationQueryParameter[]

Nilai Properti

readonly OperationQueryParameter[]

requestBody

Parameter yang akan digunakan untuk membangun isi permintaan HTTP.

requestBody?: OperationParameter

Nilai Properti

OperationParameter

responses

Berbagai jenis respons yang dapat dikembalikan operasi ini berdasarkan kode status apa yang dikembalikan.

responses: {[responseCode: string]: OperationResponse}

Nilai Properti

{[responseCode: string]: OperationResponse}

serializer

Serializer yang digunakan dalam operasi ini.

serializer: Serializer

Nilai Properti

Serializer

urlParameters

Parameter ke metode operasi yang akan diganti ke dalam URL yang dibangun.

urlParameters?: readonly OperationURLParameter[]

Nilai Properti

readonly OperationURLParameter[]