RequestPrepareOptions interface

الحزمة:

@azure/core-http

خيارات لإعداد طلب HTTP صادر.

الخصائص

abortSignal	إشارة لوحدة تحكم تم إجهاضها. يمكن استخدامها لإجهاض كل من إرسال طلب شبكة وانتظار استجابة.
baseUrl	عنوان URL الأساسي للطلب. القيمة الافتراضية هي: "https://management.azure.com". ينطبق هذا فقط مع pathTemplate. إذا كنت توفر options.url فمن المتوقع أن توفر عنوان url الكامل.
body	نص الطلب. يمكن أن يكون من أي نوع. سيتم تسلسل هذه القيمة إذا لم تكن دفق.
bodyIsStream	يشير إلى ما إذا كان نص الطلب عبارة عن دفق (مفيد لسيناريوهات تحميل الملفات).
deserializationMapper	يوفر معلومات حول كيفية إلغاء تسلسل نص الاستجابة.
disableClientRequestId	عند التعيين إلى true، يوجه العميل إلى عدم تعيين عنوان "x-ms-client-request-id" إلى Guid جديد().
disableJsonStringifyOnBody	يشير إلى ما إذا كان يجب أن يكون هذا الأسلوب JSON.stringify() نص الطلب. القيمة الافتراضية: خطأ.
formData	بيانات النموذج، المستخدمة لإنشاء نص الطلب.
headers	قاموس لرؤوس الطلبات التي يجب تطبيقها على الطلب. هنا يكون المفتاح هو "اسم الرأس" والقيمة هي "قيمة الرأس". يجب أن تكون قيمة العنوان من سلسلة النوع. يجب توفير ContentType مع اسم المفتاح ك "نوع المحتوى". القيمة الافتراضية "application/json; charset=utf-8". يتم تعيين "Transfer-Encoding" إلى "chunked" بشكل افتراضي إذا تم تعيين "options.bodyIsStream" إلى true. يتم تعيين "نوع المحتوى" إلى "application/octet-stream" بشكل افتراضي إذا تم تعيين "options.bodyIsStream" إلى true. يتم تعيين "قبول اللغة" بشكل افتراضي إلى "en-US" يتم تعيين "x-ms-client-request-id" بشكل افتراضي إلى Guid جديد. لعدم إنشاء guid للطلب، يرجى تعيين options.disableClientRequestId إلى true
mappers	قاموس معينات يمكن استخدامه أثناء [de]serialization.
method	أسلوب طلب HTTP. القيم الصالحة هي "GET" أو "PUT" أو "HEAD" أو "DELETE" أو "OPTIONS" أو "POST" أو "PATCH".
onDownloadProgress	يسمح بتتبع تقدم تنزيل الاستجابة الواردة.
onUploadProgress	يسمح بتتبع التقدم المحرز في تحميل الطلب الصادر.
pathParameters	قاموس معلمات المسار التي تحتاج إلى استبدال بقيم فعلية في pathTemplate. هنا المفتاح هو "path-parameter-name" والقيمة هي "path-parameter-value". يمكن أن يكون "path-parameter-value" من النوع "string" أو يمكن أن يكون من النوع "object". يجب استخدام تنسيق "الكائن" عندما تريد تخطي ترميز عنوان URL. أثناء استخدام تنسيق الكائن، يجب أن يكون للكائن خاصية تسمى القيمة التي توفر "path-parameter-value". مثل: path-parameter-value بتنسيق "object": { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } } path-parameter-value بتنسيق "string": { "path-parameter-name": "path-parameter-value" }.
pathTemplate	قالب مسار عنوان URL للطلب. إما توفير "url" أو توفير "pathTemplate" في عنصر الخيارات. كلا الخيارين يستبعد أحدهما الآخر. مثال: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
queryParameters	قاموس معلمات الاستعلام المراد إلحاقها بعنوان URL، حيث يكون "المفتاح" هو "اسم معلمة الاستعلام" و"القيمة" هي "قيمة معلمة الاستعلام". يمكن أن يكون "query-parameter-value" من النوع "سلسلة" أو يمكن أن يكون من النوع "كائن". يجب استخدام تنسيق "الكائن" عندما تريد تخطي ترميز عنوان URL. أثناء استخدام تنسيق الكائن، يجب أن يكون للكائن خاصية تسمى القيمة التي توفر "query-parameter-value". مثل: قيمة معلمة الاستعلام بتنسيق "كائن": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } } قيمة معلمة الاستعلام بتنسيق "سلسلة": { "query-parameter-name": "query-parameter-value"}. ملاحظة: "إذا كانت options.url تحتوي بالفعل على بعض معلمات الاستعلام، إلحاق القيمة المتوفرة في options.queryParameters بعنوان url.
serializationMapper	يوفر معلومات حول كيفية تسلسل نص الطلب.
spanOptions	التتبع: الخيارات المستخدمة لإنشاء امتداد عند تمكين التتبع.
tracingContext	التتبع: السياق المستخدم عند إنشاء النطاقات.
url	عنوان URL للطلب. قد يكون أو لا يحتوي على معلمات استعلام فيه. إما توفير "url" أو توفير "pathTemplate" في عنصر الخيارات. كلا الخيارين يستبعد أحدهما الآخر.

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

abortSignal

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

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

baseUrl

عنوان URL الأساسي للطلب. القيمة الافتراضية هي: "https://management.azure.com". ينطبق هذا فقط مع pathTemplate. إذا كنت توفر options.url فمن المتوقع أن توفر عنوان url الكامل.

baseUrl?: string

قيمة الخاصية

string

body

نص الطلب. يمكن أن يكون من أي نوع. سيتم تسلسل هذه القيمة إذا لم تكن دفق.

body?: any

قيمة الخاصية

any

bodyIsStream

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

bodyIsStream?: boolean

قيمة الخاصية

boolean

deserializationMapper

يوفر معلومات حول كيفية إلغاء تسلسل نص الاستجابة.

deserializationMapper?: Record<string, unknown>

قيمة الخاصية

Record<string, unknown>

disableClientRequestId

عند التعيين إلى true، يوجه العميل إلى عدم تعيين عنوان "x-ms-client-request-id" إلى Guid جديد().

disableClientRequestId?: boolean

قيمة الخاصية

boolean

disableJsonStringifyOnBody

يشير إلى ما إذا كان يجب أن يكون هذا الأسلوب JSON.stringify() نص الطلب. القيمة الافتراضية: خطأ.

disableJsonStringifyOnBody?: boolean

قيمة الخاصية

boolean

formData

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

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

قيمة الخاصية

{[key: string]: any}

headers

قاموس لرؤوس الطلبات التي يجب تطبيقها على الطلب. هنا يكون المفتاح هو "اسم الرأس" والقيمة هي "قيمة الرأس". يجب أن تكون قيمة العنوان من سلسلة النوع.

• يجب توفير ContentType مع اسم المفتاح ك "نوع المحتوى". القيمة الافتراضية "application/json; charset=utf-8".
• يتم تعيين "Transfer-Encoding" إلى "chunked" بشكل افتراضي إذا تم تعيين "options.bodyIsStream" إلى true.
• يتم تعيين "نوع المحتوى" إلى "application/octet-stream" بشكل افتراضي إذا تم تعيين "options.bodyIsStream" إلى true.
• يتم تعيين "قبول اللغة" بشكل افتراضي إلى "en-US"
• يتم تعيين "x-ms-client-request-id" بشكل افتراضي إلى Guid جديد. لعدم إنشاء guid للطلب، يرجى تعيين options.disableClientRequestId إلى true

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

قيمة الخاصية

{[key: string]: any}

mappers

قاموس معينات يمكن استخدامه أثناء [de]serialization.

mappers?: {[x: string]: any}

قيمة الخاصية

{[x: string]: any}

method

أسلوب طلب HTTP. القيم الصالحة هي "GET" أو "PUT" أو "HEAD" أو "DELETE" أو "OPTIONS" أو "POST" أو "PATCH".

method: HttpMethods

قيمة الخاصية

HttpMethods

onDownloadProgress

يسمح بتتبع تقدم تنزيل الاستجابة الواردة.

onDownloadProgress?: (progress: TransferProgressEvent) => void

قيمة الخاصية

(progress: TransferProgressEvent) => void

onUploadProgress

يسمح بتتبع التقدم المحرز في تحميل الطلب الصادر.

onUploadProgress?: (progress: TransferProgressEvent) => void

قيمة الخاصية

(progress: TransferProgressEvent) => void

pathParameters

قاموس معلمات المسار التي تحتاج إلى استبدال بقيم فعلية في pathTemplate. هنا المفتاح هو "path-parameter-name" والقيمة هي "path-parameter-value". يمكن أن يكون "path-parameter-value" من النوع "string" أو يمكن أن يكون من النوع "object". يجب استخدام تنسيق "الكائن" عندما تريد تخطي ترميز عنوان URL. أثناء استخدام تنسيق الكائن، يجب أن يكون للكائن خاصية تسمى القيمة التي توفر "path-parameter-value". مثل:

• path-parameter-value بتنسيق "object": { "path-parameter-name": { value: "path-parameter-value", skipUrlEncoding: true } }
• path-parameter-value بتنسيق "string": { "path-parameter-name": "path-parameter-value" }.

pathParameters?: {[key: string]: any | ParameterValue}

قيمة الخاصية

{[key: string]: any | ParameterValue}

pathTemplate

قالب مسار عنوان URL للطلب. إما توفير "url" أو توفير "pathTemplate" في عنصر الخيارات. كلا الخيارين يستبعد أحدهما الآخر. مثال: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}

pathTemplate?: string

قيمة الخاصية

string

queryParameters

قاموس معلمات الاستعلام المراد إلحاقها بعنوان URL، حيث يكون "المفتاح" هو "اسم معلمة الاستعلام" و"القيمة" هي "قيمة معلمة الاستعلام". يمكن أن يكون "query-parameter-value" من النوع "سلسلة" أو يمكن أن يكون من النوع "كائن". يجب استخدام تنسيق "الكائن" عندما تريد تخطي ترميز عنوان URL. أثناء استخدام تنسيق الكائن، يجب أن يكون للكائن خاصية تسمى القيمة التي توفر "query-parameter-value". مثل:

• قيمة معلمة الاستعلام بتنسيق "كائن": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true } }
• قيمة معلمة الاستعلام بتنسيق "سلسلة": { "query-parameter-name": "query-parameter-value"}. ملاحظة: "إذا كانت options.url تحتوي بالفعل على بعض معلمات الاستعلام، إلحاق القيمة المتوفرة في options.queryParameters بعنوان url.

queryParameters?: {[key: string]: any | ParameterValue}

قيمة الخاصية

{[key: string]: any | ParameterValue}

serializationMapper

يوفر معلومات حول كيفية تسلسل نص الطلب.

serializationMapper?: Mapper

قيمة الخاصية

Mapper

spanOptions

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

spanOptions?: SpanOptions

قيمة الخاصية

@azure/core-tracing.SpanOptions

tracingContext

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

tracingContext?: Context

قيمة الخاصية

@azure/core-tracing.Context

url

عنوان URL للطلب. قد يكون أو لا يحتوي على معلمات استعلام فيه. إما توفير "url" أو توفير "pathTemplate" في عنصر الخيارات. كلا الخيارين يستبعد أحدهما الآخر.

url?: string

قيمة الخاصية

string