WebResource class

الحزمة:

@azure/core-http

إنشاء كائن WebResource جديد.

توفر هذه الفئة تجريدا عبر استدعاء REST من خلال كونها مكتبة / تنفيذ غير محدد والتفاف الخصائص الضرورية لبدء طلب.

المنشئون

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

الخصائص

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

الأساليب

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

تفاصيل المنشئ

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

المعلمات

url

string

method

HttpMethods

body

unknown

query

{[key: string]: any}

headers

{[key: string]: any} | HttpHeadersLike

streamResponseBody

boolean

withCredentials

boolean

abortSignal

AbortSignalLike

timeout

number

onUploadProgress

(progress: TransferProgressEvent) => void

onDownloadProgress

(progress: TransferProgressEvent) => void

proxySettings

ProxySettings

keepAlive

boolean

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

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

abortSignal

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

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

body

نص الطلب.

body?: any

قيمة الخاصية

any

decompressResponse

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

decompressResponse?: boolean

قيمة الخاصية

boolean

formData

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

formData?: any

قيمة الخاصية

any

headers

عناوين HTTP.

headers: HttpHeadersLike

قيمة الخاصية

HttpHeadersLike

keepAlive

ما إذا كان يجب الاحتفاظ باتصالات HTTP على قيد الحياة خلال الطلبات.

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

مواصفات طلب HTTP.

operationSpec?: OperationSpec

قيمة الخاصية

OperationSpec

proxySettings

ما هو الوكيل الذي يجب استخدامه، إذا لزم الأمر.

proxySettings?: ProxySettings

قيمة الخاصية

ProxySettings

query

تمت إضافة الاستعلام إلى عنوان URL.

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

قيمة الخاصية

{[key: string]: any}

requestId

المعرف الفريد للطلب الصادر.

requestId: string

قيمة الخاصية

string

shouldDeserialize

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

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

قيمة الخاصية

boolean | (response: HttpOperationResponse) => boolean

spanOptions

التتبع: الخيارات المستخدمة لإنشاء امتداد عند تمكين التتبع.

spanOptions?: SpanOptions

قيمة الخاصية

@azure/core-tracing.SpanOptions

streamResponseBody

تحذير

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

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

قيمة الخاصية

boolean

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

قيمة الخاصية

Set<number>

timeout

كم من الوقت يجب الانتظار بالمللي ثانية قبل إجهاض الطلب.

timeout: number

قيمة الخاصية

number

tracingContext

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

tracingContext?: Context

قيمة الخاصية

@azure/core-tracing.Context

url

عنوان URL للطلب الصادر.

url: string

قيمة الخاصية

string

withCredentials

ما إذا كنت تريد إرسال بيانات الاعتماد (عبر ملفات تعريف الارتباط أو رؤوس التخويل أو شهادات عميل TLS) عند تقديم طلب في المتصفح إلى وجهة عبر الموقع.

withCredentials: boolean

قيمة الخاصية

boolean

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

clone()

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

function clone(): WebResource

المرتجعات

WebResource

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

prepare(RequestPrepareOptions)

إعداد الطلب.

function prepare(options: RequestPrepareOptions): WebResource

المعلمات

options

RequestPrepareOptions

خيارات لتوفير لإعداد الطلب.

المرتجعات

WebResource

إرجاع كائن WebResource (طلب HTTP) الذي يجب منحه إلى مسار الطلب.

validateRequestProperties()

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

function validateRequestProperties()