WebResourceLike interface

الحزمة:

@azure/core-http

وصف لطلب HTTP الذي سيتم إجراؤه إلى خادم بعيد.

الخصائص

abortSignal	إشارة لوحدة تحكم تم إجهاضها. يمكن استخدامها لإجهاض كل من إرسال طلب شبكة وانتظار استجابة.
body	محتويات نص HTTP للطلب.
decompressResponse	ما إذا كان يجب إلغاء ضغط الاستجابة أم لا وفقا لعنوان Accept-Encoding (إحضار العقدة فقط)
formData	بيانات النموذج، المستخدمة لإنشاء نص الطلب.
headers	عناوين HTTP لاستخدامها عند إجراء الطلب.
keepAlive	إذا كان يجب إعادة استخدام الاتصال.
method	أسلوب HTTP المراد استخدامه عند إجراء الطلب.
onDownloadProgress	رد الاتصال الذي يتم إطلاقه عند تقدم التنزيل.
onUploadProgress	رد الاتصال الذي يتم إطلاقه عند تقدم التحميل.
operationResponseGetter	دالة ترجع OperationResponse المناسبة لمجموعة OperationSpec وHttpOperationResponse المحددة. إذا كان هذا غير معرف، استخدام بحث بسيط عن التعليمات البرمجية للحالة.
operationSpec	يستخدم لتحليل الاستجابة.
proxySettings	تكوين الوكيل.
query	سلسلة استعلام ممثلة ككائن.
requestId	معرف فريد للطلب. يستخدم للتسجيل والتتبع.
shouldDeserialize	ما إذا كان يجب إلغاء تسلسل HttpOperationResponse أم لا. إذا كان هذا غير معرف، فيجب إلغاء تسلسل HttpOperationResponse.
streamResponseBody	ما إذا كان يجب التعامل مع نص HttpOperationResponse على أنه دفق أم لا.
streamResponseStatusCodes	يجب التعامل مع قائمة رموز حالة الاستجابة التي يجب التعامل مع نص HttpOperationResponse المقابل لها على أنها دفق.
timeout	عدد المللي ثانية التي يمكن أن يستغرقها الطلب قبل إنهائه تلقائيا. إذا تم إنهاء الطلب، يتم طرح AbortError.
tracingContext	التتبع: السياق المستخدم عند إنشاء النطاقات.
url	عنوان URL الذي يتم الوصول إليه بواسطة الطلب.
withCredentials	إذا كان يجب إرسال بيانات الاعتماد (ملفات تعريف الارتباط) أثناء XHR.

الأساليب

clone()	استنساخ كائن الطلب هذا.
prepare(RequestPrepareOptions)	تعيين الخيارات عند الطلب.
validateRequestProperties()	التحقق من أن الخصائص المطلوبة مثل الأسلوب وعنوان url والرؤوس ["نوع المحتوى"]، والرؤوس["قبول اللغة"] محددة. سيطرح خطأ إذا لم يتم تعريف إحدى الخصائص المذكورة أعلاه.

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

abortSignal

إشارة لوحدة تحكم تم إجهاضها. يمكن استخدامها لإجهاض كل من إرسال طلب شبكة وانتظار استجابة.

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

body

محتويات نص HTTP للطلب.

body?: any

قيمة الخاصية

any

decompressResponse

ما إذا كان يجب إلغاء ضغط الاستجابة أم لا وفقا لعنوان Accept-Encoding (إحضار العقدة فقط)

decompressResponse?: boolean

قيمة الخاصية

boolean

formData

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

formData?: any

قيمة الخاصية

any

headers

عناوين HTTP لاستخدامها عند إجراء الطلب.

headers: HttpHeadersLike

قيمة الخاصية

HttpHeadersLike

keepAlive

إذا كان يجب إعادة استخدام الاتصال.

keepAlive?: boolean

قيمة الخاصية

boolean

method

أسلوب HTTP المراد استخدامه عند إجراء الطلب.

method: HttpMethods

قيمة الخاصية

HttpMethods

onDownloadProgress

رد الاتصال الذي يتم إطلاقه عند تقدم التنزيل.

onDownloadProgress?: (progress: TransferProgressEvent) => void

قيمة الخاصية

(progress: TransferProgressEvent) => void

onUploadProgress

رد الاتصال الذي يتم إطلاقه عند تقدم التحميل.

onUploadProgress?: (progress: TransferProgressEvent) => void

قيمة الخاصية

(progress: TransferProgressEvent) => void

operationResponseGetter

دالة ترجع OperationResponse المناسبة لمجموعة OperationSpec وHttpOperationResponse المحددة. إذا كان هذا غير معرف، استخدام بحث بسيط عن التعليمات البرمجية للحالة.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

قيمة الخاصية

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

يستخدم لتحليل الاستجابة.

operationSpec?: OperationSpec

قيمة الخاصية

OperationSpec

proxySettings

تكوين الوكيل.

proxySettings?: ProxySettings

قيمة الخاصية

ProxySettings

query

سلسلة استعلام ممثلة ككائن.

query?: {[key: string]: any}

قيمة الخاصية

{[key: string]: any}

requestId

معرف فريد للطلب. يستخدم للتسجيل والتتبع.

requestId: string

قيمة الخاصية

string

shouldDeserialize

ما إذا كان يجب إلغاء تسلسل HttpOperationResponse أم لا. إذا كان هذا غير معرف، فيجب إلغاء تسلسل HttpOperationResponse.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

قيمة الخاصية

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use streamResponseStatusCodes property instead.

ما إذا كان يجب التعامل مع نص HttpOperationResponse على أنه دفق أم لا.

streamResponseBody?: boolean

قيمة الخاصية

boolean

streamResponseStatusCodes

يجب التعامل مع قائمة رموز حالة الاستجابة التي يجب التعامل مع نص HttpOperationResponse المقابل لها على أنها دفق.

streamResponseStatusCodes?: Set<number>

قيمة الخاصية

Set<number>

timeout

عدد المللي ثانية التي يمكن أن يستغرقها الطلب قبل إنهائه تلقائيا. إذا تم إنهاء الطلب، يتم طرح AbortError.

timeout: number

قيمة الخاصية

number

tracingContext

التتبع: السياق المستخدم عند إنشاء النطاقات.

tracingContext?: Context

قيمة الخاصية

@azure/core-tracing.Context

url

عنوان URL الذي يتم الوصول إليه بواسطة الطلب.

url: string

قيمة الخاصية

string

withCredentials

إذا كان يجب إرسال بيانات الاعتماد (ملفات تعريف الارتباط) أثناء XHR.

withCredentials: boolean

قيمة الخاصية

boolean

تفاصيل الأسلوب

clone()

استنساخ كائن الطلب هذا.

function clone(): WebResourceLike

المرتجعات

WebResourceLike

prepare(RequestPrepareOptions)

تعيين الخيارات عند الطلب.

function prepare(options: RequestPrepareOptions): WebResourceLike

المعلمات

options

RequestPrepareOptions

المرتجعات

WebResourceLike

validateRequestProperties()

التحقق من أن الخصائص المطلوبة مثل الأسلوب وعنوان url والرؤوس ["نوع المحتوى"]، والرؤوس["قبول اللغة"] محددة. سيطرح خطأ إذا لم يتم تعريف إحدى الخصائص المذكورة أعلاه.

function validateRequestProperties()