OperationSpec interface

الحزمة:

@azure/ms-rest-js

مواصفات تحدد عملية.

الخصائص

baseUrl	عنوان URL الذي تم توفيره في مواصفات الخدمة. سيظل هذا يحتوي على جميع متغيرات قالب URL فيه. إذا لم يتم توفير هذا عند إنشاء OperationSpec، فسيتم ملؤه بواسطة خاصية "baseUri" على ServiceClient.
contentType	نوع محتوى نص الطلب. سيتم استخدام هذه القيمة كعنوان "نوع المحتوى" إذا تم توفيرها.
formDataParameters	معلمات أسلوب العملية التي سيتم استخدامها لإنشاء نص بيانات النموذج لطلب HTTP الخاص بالعملية.
headerParameters	المعلمات إلى أسلوب العملية التي سيتم تحويلها إلى رؤوس على طلب HTTP الخاص بالعملية.
httpMethod	أسلوب HTTP الذي يجب استخدامه بواسطة طلبات هذه العملية.
isXML	ما إذا كانت هذه العملية تستخدم هيئات طلب واستجابة XML أم لا.
path	المسار الثابت لعنون URL الخاص بهذه العملية. سيظل هذا يحتوي على جميع متغيرات قالب URL فيه.
queryParameters	المعلمات إلى أسلوب العملية التي ستتم إضافتها إلى استعلام URL الذي تم إنشاؤه.
requestBody	المعلمة التي سيتم استخدامها لإنشاء نص طلب HTTP.
responses	الأنواع المختلفة من الاستجابات التي يمكن أن ترجعها هذه العملية استنادا إلى رمز الحالة الذي يتم إرجاعه.
serializer	المتسلسل الذي يجب استخدامه في هذه العملية.
urlParameters	المعلمات لأسلوب العملية التي سيتم استبدالها في عنوان URL الذي تم إنشاؤه.

تفاصيل الخاصية

baseUrl

عنوان URL الذي تم توفيره في مواصفات الخدمة. سيظل هذا يحتوي على جميع متغيرات قالب URL فيه. إذا لم يتم توفير هذا عند إنشاء OperationSpec، فسيتم ملؤه بواسطة خاصية "baseUri" على ServiceClient.

baseUrl?: string

قيمة الخاصية

string

contentType

نوع محتوى نص الطلب. سيتم استخدام هذه القيمة كعنوان "نوع المحتوى" إذا تم توفيرها.

contentType?: string

قيمة الخاصية

string

formDataParameters

معلمات أسلوب العملية التي سيتم استخدامها لإنشاء نص بيانات النموذج لطلب HTTP الخاص بالعملية.

formDataParameters?: readonly OperationParameter[]

قيمة الخاصية

readonly OperationParameter[]

headerParameters

المعلمات إلى أسلوب العملية التي سيتم تحويلها إلى رؤوس على طلب HTTP الخاص بالعملية.

headerParameters?: readonly OperationParameter[]

قيمة الخاصية

readonly OperationParameter[]

httpMethod

أسلوب HTTP الذي يجب استخدامه بواسطة طلبات هذه العملية.

httpMethod: HttpMethods

قيمة الخاصية

HttpMethods

isXML

ما إذا كانت هذه العملية تستخدم هيئات طلب واستجابة XML أم لا.

isXML?: boolean

قيمة الخاصية

boolean

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