RequestOptions interface

الحزمة:

@azure/cosmos

الخيارات التي يمكن تحديدها لإصدار مطلوب لخوادم Azure Cosmos DB.=

Extends

SharedOptions

الخصائص

accessCondition	الشروط المقترنة بالطلب.
consistencyLevel	مستوى التناسق المطلوب من قبل العميل.
disableAutomaticIdGeneration	تعطيل إنشاء المعرف التلقائي (سيؤدي إلى فشل عمليات الإنشاء إذا لم يكن المعرف في التعريف)
disableRUPerMinuteUsage	يتم استخدام DisableRUPerMinuteUsage لتمكين/تعطيل سعة وحدات الطلب (RUs)/دقيقة لخدمة الطلب إذا تم استنفاد وحدات الطلب/الثانية المتوفرة بانتظام.
enableScriptLogging	تمكين تسجيل الدخول إلى إجراءات JavaScript المخزنة أو تعطيله.
indexingDirective	يحدد توجيهات الفهرسة (الفهرس، لا تقم بفهرسة .. إلخ).
offerThroughput	معدل نقل العرض المقدم لحاوية في قياس الطلبات لكل وحدة.
offerType	نوع العرض عند إنشاء حاويات المستندات. هذا الخيار صالح فقط عند إنشاء حاوية مستند.
populateQuotaInfo	تمكين/تعطيل الحصول على الحصة النسبية لحاوية المستندات ذات الصلة بطلبات قراءة حاوية المستند.
postTriggerInclude	يشير إلى ما هو مشغل النشر الذي سيتم استدعاؤه بعد العملية.
preTriggerInclude	يشير إلى ما هو المشغل المسبق الذي سيتم استدعاؤه قبل العملية.
resourceTokenExpirySeconds	وقت انتهاء الصلاحية (بالثوان) للرمز المميز للمورد المقترن بالإذن (ينطبق فقط على الطلبات على الأذونات).
urlConnection	(حالة الاستخدام المتقدمة) عنوان URL للاتصال به.

الخصائص الموروثة

abortSignal	abortSignal لتمريرها إلى جميع طلبات الشبكة الأساسية التي تم إنشاؤها بواسطة استدعاء الأسلوب هذا. راجع https://developer.mozilla.org/en-US/docs/Web/API/AbortController مثال إلغاء طلب قراءة const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()
initialHeaders	(حالة الاستخدام المتقدمة) العناوين الأولية التي يجب البدء بها عند إرسال الطلبات إلى Cosmos
maxIntegratedCacheStalenessInMs	تعيين قيمة staleness المقترنة بالطلب في خدمة Azure CosmosDB. بالنسبة للطلبات حيث <xref:com.azure.cosmos.ConsistencyLevel> يكون أو <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL><xref:com.azure.cosmos.ConsistencyLevel%23SESSION>، يتم ضمان الاستجابات من ذاكرة التخزين المؤقت المتكاملة لتكون لا تالفة من القيمة المشار إليها بواسطة maxIntegratedCacheStaleness هذا. عند عدم تعيين مستوى التناسق، يتم تجاهل هذه الخاصية. القيمة الافتراضية فارغة ذاكرة التخزين المؤقت Staleness مدعومة بنقاوة بالمللي ثانية. سيتم تجاهل أي شيء أصغر من مللي ثانية.
priorityLevel	مستوى الأولوية (منخفض/مرتفع) لكل طلب. يتم دائما تقييد الطلبات ذات الأولوية المنخفضة قبل أي طلبات ذات أولوية عالية. القيمة الافتراضية فارغة. بشكل افتراضي، تكون جميع الطلبات ذات أولوية عالية
sessionToken	تمكين/تعطيل الحصول على الحصة النسبية لحاوية المستندات ذات الصلة بطلبات قراءة حاوية المستند.

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

accessCondition

الشروط المقترنة بالطلب.

accessCondition?: { condition: string, type: string }

قيمة الخاصية

{ condition: string, type: string }

consistencyLevel

مستوى التناسق المطلوب من قبل العميل.

consistencyLevel?: string

قيمة الخاصية

string

disableAutomaticIdGeneration

تعطيل إنشاء المعرف التلقائي (سيؤدي إلى فشل عمليات الإنشاء إذا لم يكن المعرف في التعريف)

disableAutomaticIdGeneration?: boolean

قيمة الخاصية

boolean

disableRUPerMinuteUsage

يتم استخدام DisableRUPerMinuteUsage لتمكين/تعطيل سعة وحدات الطلب (RUs)/دقيقة لخدمة الطلب إذا تم استنفاد وحدات الطلب/الثانية المتوفرة بانتظام.

disableRUPerMinuteUsage?: boolean

قيمة الخاصية

boolean

enableScriptLogging

تمكين تسجيل الدخول إلى إجراءات JavaScript المخزنة أو تعطيله.

enableScriptLogging?: boolean

قيمة الخاصية

boolean

indexingDirective

يحدد توجيهات الفهرسة (الفهرس، لا تقم بفهرسة .. إلخ).

indexingDirective?: string

قيمة الخاصية

string

offerThroughput

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

offerThroughput?: number

قيمة الخاصية

number

offerType

نوع العرض عند إنشاء حاويات المستندات.

هذا الخيار صالح فقط عند إنشاء حاوية مستند.

offerType?: string

قيمة الخاصية

string

populateQuotaInfo

تمكين/تعطيل الحصول على الحصة النسبية لحاوية المستندات ذات الصلة بطلبات قراءة حاوية المستند.

populateQuotaInfo?: boolean

قيمة الخاصية

boolean

postTriggerInclude

يشير إلى ما هو مشغل النشر الذي سيتم استدعاؤه بعد العملية.

postTriggerInclude?: string | string[]

قيمة الخاصية

string | string[]

preTriggerInclude

يشير إلى ما هو المشغل المسبق الذي سيتم استدعاؤه قبل العملية.

preTriggerInclude?: string | string[]

قيمة الخاصية

string | string[]

resourceTokenExpirySeconds

وقت انتهاء الصلاحية (بالثوان) للرمز المميز للمورد المقترن بالإذن (ينطبق فقط على الطلبات على الأذونات).

resourceTokenExpirySeconds?: number

قيمة الخاصية

number

urlConnection

(حالة الاستخدام المتقدمة) عنوان URL للاتصال به.

urlConnection?: string

قيمة الخاصية

string

تفاصيل الخاصية الموروثة

abortSignal

abortSignal لتمريرها إلى جميع طلبات الشبكة الأساسية التي تم إنشاؤها بواسطة استدعاء الأسلوب هذا. راجع https://developer.mozilla.org/en-US/docs/Web/API/AbortController

مثال

إلغاء طلب قراءة

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()

abortSignal?: AbortSignal

قيمة الخاصية

AbortSignal

موروث منSharedOptions.abortSignal

initialHeaders

(حالة الاستخدام المتقدمة) العناوين الأولية التي يجب البدء بها عند إرسال الطلبات إلى Cosmos

initialHeaders?: CosmosHeaders

قيمة الخاصية

CosmosHeaders

موروث منSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

تعيين قيمة staleness المقترنة بالطلب في خدمة Azure CosmosDB. بالنسبة للطلبات حيث <xref:com.azure.cosmos.ConsistencyLevel> يكون أو <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL><xref:com.azure.cosmos.ConsistencyLevel%23SESSION>، يتم ضمان الاستجابات من ذاكرة التخزين المؤقت المتكاملة لتكون لا تالفة من القيمة المشار إليها بواسطة maxIntegratedCacheStaleness هذا. عند عدم تعيين مستوى التناسق، يتم تجاهل هذه الخاصية.

القيمة الافتراضية فارغة

ذاكرة التخزين المؤقت Staleness مدعومة بنقاوة بالمللي ثانية. سيتم تجاهل أي شيء أصغر من مللي ثانية.

maxIntegratedCacheStalenessInMs?: number

قيمة الخاصية

number

موروث منSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

مستوى الأولوية (منخفض/مرتفع) لكل طلب. يتم دائما تقييد الطلبات ذات الأولوية المنخفضة قبل أي طلبات ذات أولوية عالية.

القيمة الافتراضية فارغة. بشكل افتراضي، تكون جميع الطلبات ذات أولوية عالية

priorityLevel?: PriorityLevel

قيمة الخاصية

PriorityLevel

موروث منSharedOptions.priorityLevel

sessionToken

تمكين/تعطيل الحصول على الحصة النسبية لحاوية المستندات ذات الصلة بطلبات قراءة حاوية المستند.

sessionToken?: string

قيمة الخاصية

string

موروث منSharedOptions.sessionToken