WebResource interface

الحزمة:

@azure/storage-blob

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

الخصائص

abortSignal	إشارة لوحدة تحكم تم إجهاضها. يمكن استخدامها لإجهاض كل من إرسال طلب شبكة وانتظار استجابة.
agent	NODEJS فقط خيار عقدة فقط لتوفير http.Agent/https.Agentمخصص . ملاحظة: عادة ما يجب أن يكون هذا مثيل واحد مشترك بواسطة طلبات متعددة بحيث يمكن إعادة استخدام الاتصال الأساسي بالخدمة. لا يفعل شيئا عند التشغيل في المستعرض.
body	محتويات نص HTTP للطلب.
decompressResponse	ما إذا كان يجب إلغاء ضغط الاستجابة أم لا وفقا لعنوان Accept-Encoding (إحضار العقدة فقط)
formData	بيانات النموذج، المستخدمة لإنشاء نص الطلب.
headers	عناوين HTTP لاستخدامها عند إجراء الطلب.
keepAlive	إذا كان يجب إعادة استخدام الاتصال.
method	أسلوب HTTP المراد استخدامه عند إجراء الطلب.
onDownloadProgress	رد الاتصال الذي يتم إطلاقه عند تقدم التنزيل.
onUploadProgress	رد الاتصال الذي يتم إطلاقه عند تقدم التحميل.
proxySettings	تكوين الوكيل.
query	سلسلة استعلام ممثلة ككائن.
requestId	معرف فريد للطلب. يستخدم للتسجيل والتتبع.
requestOverrides	خيارات إضافية لتعيينها عند الطلب. يوفر هذا طريقة لتجاوز الخصائص الموجودة أو توفير خصائص الطلب التي لم يتم الإعلان عنها. للتعرف على الخصائص الصالحة المحتملة، راجع خيارات NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback طلب المتصفحInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit تحذير: ستتجاوز الخيارات المحددة هنا أي خصائص بنفس الأسماء عند إرسال الطلب بواسطة <xref:HttpClient>.
streamResponseBody	ما إذا كان يجب التعامل مع نص HttpOperationResponse على أنه دفق أم لا.
streamResponseStatusCodes	يجب التعامل مع قائمة رموز حالة الاستجابة التي يجب التعامل مع نص HttpOperationResponse المقابل لها على أنها دفق.
timeout	عدد المللي ثانية التي يمكن أن يستغرقها الطلب قبل إنهائه تلقائيا. إذا تم إنهاء الطلب، يتم طرح AbortError.
url	عنوان URL الذي يتم الوصول إليه بواسطة الطلب.
withCredentials	إذا كان يجب إرسال بيانات الاعتماد (ملفات تعريف الارتباط) أثناء XHR.

الأساليب

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

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

abortSignal

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

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

agent

NODEJS فقط

خيار عقدة فقط لتوفير http.Agent/https.Agentمخصص . ملاحظة: عادة ما يجب أن يكون هذا مثيل واحد مشترك بواسطة طلبات متعددة بحيث يمكن إعادة استخدام الاتصال الأساسي بالخدمة. لا يفعل شيئا عند التشغيل في المستعرض.

agent?: Agent

قيمة الخاصية

Agent

body

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

body?: any

قيمة الخاصية

any

decompressResponse

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

decompressResponse?: boolean

قيمة الخاصية

boolean

formData

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

formData?: any

قيمة الخاصية

any

headers

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

headers: HttpHeadersLike

قيمة الخاصية

HttpHeaders

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

proxySettings

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

proxySettings?: ProxySettings

قيمة الخاصية

ProxySettings

query

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

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

قيمة الخاصية

{[key: string]: any}

requestId

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

requestId: string

قيمة الخاصية

string

requestOverrides

خيارات إضافية لتعيينها عند الطلب. يوفر هذا طريقة لتجاوز الخصائص الموجودة أو توفير خصائص الطلب التي لم يتم الإعلان عنها.

للتعرف على الخصائص الصالحة المحتملة، راجع

• خيارات NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback
• طلب المتصفحInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

تحذير: ستتجاوز الخيارات المحددة هنا أي خصائص بنفس الأسماء عند إرسال الطلب بواسطة <xref:HttpClient>.

requestOverrides?: Record<string, unknown>

قيمة الخاصية

Record<string, unknown>

streamResponseBody

تحذير

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

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

قيمة الخاصية

boolean

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

قيمة الخاصية

Set<number>

timeout

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

timeout: number

قيمة الخاصية

number

url

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

url: string

قيمة الخاصية

string

withCredentials

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

withCredentials: boolean

قيمة الخاصية

boolean

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

clone()

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

function clone(): WebResourceLike

المرتجعات

WebResource

prepare(unknown)

هذا هو no-op لأغراض توافق وسوف رمي إذا استدعى.

function prepare(options: unknown): WebResourceLike

المعلمات

options

unknown

المرتجعات

WebResource

validateRequestProperties()

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

function validateRequestProperties()