RequestPrepareOptions interface

الحزمة:

@azure/ms-rest-js

الخصائص

abortSignal
baseUrl	عنوان URL الأساسي للطلب. القيمة الافتراضية هي: "https://management.azure.com". ينطبق هذا فقط مع pathTemplate. إذا كنت توفر options.url، فمن المتوقع أن توفر عنوان url الكامل.
body	نص الطلب. يمكن أن يكون من أي نوع. سيتم تسلسل هذه القيمة إذا لم تكن دفقا.
bodyIsStream	يشير إلى ما إذا كان نص الطلب عبارة عن دفق (مفيد لسيناريوهات تحميل الملفات).
deserializationMapper	يوفر معلومات حول كيفية إلغاء تسلسل نص الاستجابة.
disableClientRequestId	عند التعيين إلى صحيح، يرشد العميل إلى عدم تعيين عنوان "x-ms-client-request-id" إلى Guid جديد().
disableJsonStringifyOnBody	يشير إلى ما إذا كان يجب أن يكون هذا الأسلوب JSON.stringify() نص الطلب. القيمة الافتراضية: false.
formData
headers	قاموس لرؤوس الطلبات التي تحتاج إلى تطبيقها على الطلب. هنا المفتاح هو "اسم الرأس" والقيمة هي "قيمة الرأس". يجب أن تكون قيمة الرأس من سلسلة النوع. يجب تزويد ContentType باسم المفتاح ك "نوع المحتوى". القيمة الافتراضية "application/json; charset=utf-8". يتم تعيين "Transfer-Encoding" إلى "مقسم" بشكل افتراضي إذا تم تعيين "options.bodyIsStream" إلى true. يتم تعيين "نوع المحتوى" إلى "application/octet-stream" بشكل افتراضي إذا تم تعيين "options.bodyIsStream" إلى true. يتم تعيين "قبول اللغة" بشكل افتراضي إلى "en-US" يتم تعيين "x-ms-client-request-id" بشكل افتراضي إلى 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". يمكن أن تكون "قيمة معلمة المسار" من النوع "سلسلة" أو يمكن أن تكون من النوع "كائن". يجب استخدام تنسيق "الكائن" عندما تريد تخطي ترميز عنوان 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-name" و"value" هو "query-parameter-value". يمكن أن تكون "query-parameter-value" من نوع "سلسلة" أو يمكن أن تكون من النوع "كائن". يجب استخدام تنسيق "الكائن" عندما تريد تخطي ترميز عنوان URL. أثناء استخدام تنسيق العنصر، يجب أن يكون للكائن خاصية تسمى القيمة التي توفر "query-parameter-value". مثال: query-parameter-value بتنسيق "object": { "query-parameter-name": { value: "query-parameter-value", skipUrlEncoding: true} } query-parameter-value بتنسيق "string": { "query-parameter-name": "query-parameter-value"}. ملاحظة: "إذا كان options.url يحتوي بالفعل على بعض معلمات الاستعلام، فسيتم إلحاق القيمة المتوفرة في options.queryParameters بعنوان url.
redirectLimit	حدد عدد عمليات إعادة التوجيه المتبعة لهذا الطلب. إذا تم تعيينه إلى 0، فلن يتم اتباع عمليات إعادة التوجيه. إذا لم يتم تحديد سلوك إعادة التوجيه الافتراضي node_fetch الأساسي، فسيتم تطبيقه.
serializationMapper	يوفر معلومات حول كيفية تسلسل نص الطلب.
streamResponseBody
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?: object

قيمة الخاصية

object

disableClientRequestId

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

disableClientRequestId?: boolean

قيمة الخاصية

boolean

disableJsonStringifyOnBody

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

disableJsonStringifyOnBody?: boolean

قيمة الخاصية

boolean

formData

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

قيمة الخاصية

{[key: string]: any}

headers

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

• يجب تزويد ContentType باسم المفتاح ك "نوع المحتوى". القيمة الافتراضية "application/json; charset=utf-8".
• يتم تعيين "Transfer-Encoding" إلى "مقسم" بشكل افتراضي إذا تم تعيين "options.bodyIsStream" إلى true.
• يتم تعيين "نوع المحتوى" إلى "application/octet-stream" بشكل افتراضي إذا تم تعيين "options.bodyIsStream" إلى true.
• يتم تعيين "قبول اللغة" بشكل افتراضي إلى "en-US"
• يتم تعيين "x-ms-client-request-id" بشكل افتراضي إلى 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". يمكن أن تكون "قيمة معلمة المسار" من النوع "سلسلة" أو يمكن أن تكون من النوع "كائن". يجب استخدام تنسيق "الكائن" عندما تريد تخطي ترميز عنوان 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-name" و"value" هو "query-parameter-value". يمكن أن تكون "query-parameter-value" من نوع "سلسلة" أو يمكن أن تكون من النوع "كائن". يجب استخدام تنسيق "الكائن" عندما تريد تخطي ترميز عنوان URL. أثناء استخدام تنسيق العنصر، يجب أن يكون للكائن خاصية تسمى القيمة التي توفر "query-parameter-value". مثال:

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

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

قيمة الخاصية

{[key: string]: any | ParameterValue}

redirectLimit

حدد عدد عمليات إعادة التوجيه المتبعة لهذا الطلب. إذا تم تعيينه إلى 0، فلن يتم اتباع عمليات إعادة التوجيه. إذا لم يتم تحديد سلوك إعادة التوجيه الافتراضي node_fetch الأساسي، فسيتم تطبيقه.

redirectLimit?: number

قيمة الخاصية

number

serializationMapper

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

serializationMapper?: Mapper

قيمة الخاصية

Mapper

streamResponseBody

streamResponseBody?: boolean

قيمة الخاصية

boolean

url

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

url?: string

قيمة الخاصية

string