PipelineRequestOptions interface

الحزمة:

@azure/core-rest-pipeline

إعدادات لتهيئة طلب. يكاد يكون مكافئا ل Partial<PipelineRequest>، ولكن عنوان url إلزامي.

الخصائص

abortSignal	يستخدم لإجهاض الطلب لاحقا.
agent	NODEJS فقط خيار عقدة فقط لتوفير http.Agent/https.Agentمخصص . ملاحظة: عادة ما يجب أن يكون هذا مثيل واحد مشترك بواسطة طلبات متعددة بحيث يمكن إعادة استخدام الاتصال الأساسي بالخدمة. لا يفعل شيئا عند التشغيل في المستعرض.
allowInsecureConnection	تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS
body	محتوى نص HTTP (إن وجد)
disableKeepAlive	إذا كان لا ينبغي إعادة استخدام الاتصال.
enableBrowserStreams	المستعرض فقط خيار مستعرض فقط لتمكين استخدام Streams API. إذا تم تعيين هذا الخيار وتم استخدام الدفق (راجع streamResponseStatusCodes)، فسيكون للاستجابة خاصية browserStream بدلا من blobBody التي ستكون غير معرفة. القيمة الافتراضية خاطئة
formData	لمحاكاة منشور نموذج مستعرض
headers	عناوين HTTP لاستخدامها عند إجراء الطلب.
method	أسلوب HTTP المراد استخدامه عند إجراء الطلب.
multipartBody	نص طلب متعدد الأحزاب.
onDownloadProgress	رد الاتصال الذي يتم إطلاقه عند تقدم التنزيل.
onUploadProgress	رد الاتصال الذي يتم إطلاقه عند تقدم التحميل.
proxySettings	تكوين الوكيل.
requestId	معرف فريد للطلب. يستخدم للتسجيل والتتبع.
requestOverrides	خيارات إضافية لتعيينها عند الطلب. يوفر هذا طريقة لتجاوز الخصائص الموجودة أو توفير خصائص الطلب التي لم يتم الإعلان عنها. للتعرف على الخصائص الصالحة المحتملة، راجع خيارات NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback طلب المتصفحInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit تحذير: ستقوم الخيارات المحددة هنا بتجاوز أي خصائص تحمل نفس الأسماء عند إرسال الطلب بواسطة HttpClient.
streamResponseStatusCodes	قائمة رموز حالة الاستجابة التي يجب التعامل مع نص PipelineResponse المقابل لها كتدفق.
timeout	عدد المللي ثانية التي يمكن أن يستغرقها الطلب قبل إنهائه تلقائيا. إذا تم إنهاء الطلب، يتم طرح AbortError. الإعدادات الافتراضية إلى 0، مما يعطل المهلة.
tlsSettings	إعدادات تكوين مصادقة TLS
tracingOptions	الخيارات المستخدمة لإنشاء نطاق عند تمكين التتبع.
url	عنوان URL لتقديم الطلب إليه.
withCredentials	إذا كان يجب إرسال بيانات الاعتماد (ملفات تعريف الارتباط) أثناء XHR. الإعدادات الافتراضية للخطأ.

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

abortSignal

يستخدم لإجهاض الطلب لاحقا.

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

agent

NODEJS فقط

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

agent?: Agent

قيمة الخاصية

Agent

allowInsecureConnection

تعيين إلى صحيح إذا تم إرسال الطلب عبر HTTP بدلا من HTTPS

allowInsecureConnection?: boolean

قيمة الخاصية

boolean

body

محتوى نص HTTP (إن وجد)

body?: RequestBodyType

قيمة الخاصية

RequestBodyType

disableKeepAlive

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

disableKeepAlive?: boolean

قيمة الخاصية

boolean

enableBrowserStreams

المستعرض فقط

خيار مستعرض فقط لتمكين استخدام Streams API. إذا تم تعيين هذا الخيار وتم استخدام الدفق (راجع streamResponseStatusCodes)، فسيكون للاستجابة خاصية browserStream بدلا من blobBody التي ستكون غير معرفة.

القيمة الافتراضية خاطئة

enableBrowserStreams?: boolean

قيمة الخاصية

boolean

formData

لمحاكاة منشور نموذج مستعرض

formData?: FormDataMap

قيمة الخاصية

FormDataMap

headers

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

headers?: HttpHeaders

قيمة الخاصية

HttpHeaders

method

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

method?: HttpMethods

قيمة الخاصية

HttpMethods

multipartBody

نص طلب متعدد الأحزاب.

multipartBody?: MultipartRequestBody

قيمة الخاصية

MultipartRequestBody

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

قيمة الخاصية

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

قيمة الخاصية

(progress: TransferProgressEvent) => void

proxySettings

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

proxySettings?: ProxySettings

قيمة الخاصية

ProxySettings

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

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

requestOverrides?: Record<string, unknown>

قيمة الخاصية

Record<string, unknown>

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

قيمة الخاصية

Set<number>

timeout

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

timeout?: number

قيمة الخاصية

number

tlsSettings

إعدادات تكوين مصادقة TLS

tlsSettings?: TlsSettings

قيمة الخاصية

TlsSettings

tracingOptions

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

tracingOptions?: OperationTracingOptions

قيمة الخاصية

OperationTracingOptions

url

عنوان URL لتقديم الطلب إليه.

url: string

قيمة الخاصية

string

withCredentials

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

withCredentials?: boolean

قيمة الخاصية

boolean