RequestOptions interface

الحزمة:

@azure/cosmos

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

يمتد

SharedOptions

الخصائص

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

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

abortSignal	abortSignal لتمرير إلى كافة طلبات الشبكة الأساسية التي تم إنشاؤها بواسطة استدعاء الأسلوب هذا. راجع https://developer.mozilla.org/en-US/docs/Web/API/AbortController المثال إلغاء طلب قراءة import { CosmosClient } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const { database } = await client.databases.createIfNotExists({ id: "Test Database" }); const { container } = await database.containers.createIfNotExists({ id: "Test Container" }); const controller = new AbortController(); const results = container.items.query("SELECT * from c", { abortSignal: controller.signal, });
bypassIntegratedCache	تعيين ما إذا كان يجب تجاوز ذاكرة التخزين المؤقت المتكاملة أو تمكينها للطلب في خدمة Azure CosmosDB. القيمة الافتراضية خاطئة. يتم تمكين ذاكرة التخزين المؤقت المتكاملة بشكل افتراضي
consistencyLevel	مستوى التناسق المطلوب من قبل العميل.
disableRUPerMinuteUsage	يتم استخدام DisableRUPerMinuteUsage لتمكين/تعطيل سعة وحدات الطلب (RUs)/دقيقة لخدمة الطلب إذا تم استنفاد وحدات الطلب/الثانية المتوفرة العادية.
excludedLocations	يستبعد منطقة Azure واحدة أو أكثر للعملية. يتم تطبيق هذا الخيار فقط عند تعيين enableEndPointDiscovery إلى true.
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	تمكين/تعطيل الحصول على الإحصائيات ذات الصلة بالحصة النسبية لحاوية المستندات لطلبات قراءة حاوية المستند.
throughputBucket	دلو الإنتاجية لطلب. القيمة الافتراضية خالية. في هذه الحالة، يمكن للطلب استخدام 100% من معدل نقل القسم. لمزيد من المعلومات، تفضل بزيارة [مستودع إنتاجية Cosmos DB](https://aka.ms/cosmsodb-bucketing).

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

accessCondition

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

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

قيمة الخاصية

{ condition: string, type: string }

contentResponseOnWriteEnabled

إذا تم تعيينه إلى false، فلن ترجع الخدمة الحمولة في الاستجابة. يقلل من حمل الشبكة ووحدة المعالجة المركزية عن طريق عدم إرسال الحمولة مرة أخرى عبر الشبكة. القيمة الافتراضية صحيحة.

ملاحظة: حاليا، هذا الخيار مدعوم فقط للعمليات المجمعة والدفعية.

contentResponseOnWriteEnabled?: boolean

قيمة الخاصية

boolean

disableAutomaticIdGeneration

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

disableAutomaticIdGeneration?: 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

المثال

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

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

قيمة الخاصية

AbortSignal

موروث منSharedOptions.abortSignal

bypassIntegratedCache

تعيين ما إذا كان يجب تجاوز ذاكرة التخزين المؤقت المتكاملة أو تمكينها للطلب في خدمة Azure CosmosDB.

القيمة الافتراضية خاطئة. يتم تمكين ذاكرة التخزين المؤقت المتكاملة بشكل افتراضي

bypassIntegratedCache?: boolean

قيمة الخاصية

boolean

موروث منSharedOptions.bypassIntegratedCache

consistencyLevel

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

consistencyLevel?: string

قيمة الخاصية

string

موروثة منSharedOptions.consistencyLevel

disableRUPerMinuteUsage

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

disableRUPerMinuteUsage?: boolean

قيمة الخاصية

boolean

موروثة منSharedOptions.disableRUPerMinuteUsage

excludedLocations

يستبعد منطقة Azure واحدة أو أكثر للعملية.

يتم تطبيق هذا الخيار فقط عند تعيين enableEndPointDiscovery إلى true.

excludedLocations?: string[]

قيمة الخاصية

string[]

موروثة منSharedOptions.excludedLocations

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

throughputBucket

دلو الإنتاجية لطلب.

القيمة الافتراضية خالية. في هذه الحالة، يمكن للطلب استخدام 100% من معدل نقل القسم.

لمزيد من المعلومات، تفضل بزيارة [مستودع إنتاجية Cosmos DB](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

قيمة الخاصية

number

موروثة منSharedOptions.throughputBucket