CosmosDBv4FunctionOptions interface

الحزمة:

@azure/functions

يمتد

CosmosDBv4TriggerOptions,Partial<FunctionOptions>

الخصائص

handler
retry	نهج إعادة محاولة اختياري لإعادة تشغيل تنفيذ فاشل حتى يحدث إكمال ناجح أو يتم الوصول إلى الحد الأقصى لعدد مرات إعادة المحاولة. تعرف على المزيد هنا
trigger

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

connection	إعداد تطبيق (أو متغير بيئة) مع سلسلة اتصال Cosmos DB
containerName	اسم الحاوية التي تتم مراقبتها
createLeaseContainerIfNotExists	التحقق من وجود وإنشاء حاوية عقود الإيجار تلقائيا. الافتراضي هو false
databaseName	اسم قاعدة بيانات Azure Cosmos DB مع مراقبة الحاوية
extraInputs	تكوين مجموعة اختيارية من المدخلات الثانوية أثناء استدعاء، احصل على هذه القيم مع context.extraInputs.get()
extraOutputs	تكوين مجموعة اختيارية من المخرجات الثانوية أثناء استدعاء، قم بتعيين هذه القيم مع context.extraOutputs.set()
feedPollDelay	الوقت (بالمللي ثانية) للتأخير بين الاستقصاء عن قسم للتغييرات الجديدة على الموجز، بعد استنزاف جميع التغييرات الحالية. الافتراضي هو 5000 مللي ثانية أو 5 ثوان.
leaseAcquireInterval	عند التعيين، فإنه يحدد، بالمللي ثانية، الفاصل الزمني لبدء مهمة لحساب إذا تم توزيع الأقسام بالتساوي بين مثيلات المضيف المعروفة. الافتراضي هو 13000 (13 ثانية).
leaseConnection	اسم إعداد تطبيق يحتوي على سلسلة الاتصال بالخدمة التي تحتوي على حاوية التأجير. إذا لم يتم تعيينه، فسيتصل بالخدمة المحددة بواسطة connection
leaseContainerName	اسم الحاوية لتخزين عقود الإيجار. إذا لم يتم تعيينه، فسيستخدم "عقود الإيجار"
leaseContainerPrefix	عند التعيين، تتم إضافة القيمة كبادئة إلى عقود الإيجار التي تم إنشاؤها في حاوية التأجير لهذه الدالة. يسمح استخدام بادئة لدالتي Azure منفصلتين بمشاركة نفس حاوية التأجير باستخدام بادئات مختلفة.
leaseDatabaseName	اسم قاعدة البيانات التي تحتوي على الحاوية لتخزين عقود الإيجار. إذا لم يتم تعيينه، فسيستخدم قيمة databaseName
leaseExpirationInterval	عند التعيين، فإنه يحدد، بالمللي ثانية، الفاصل الزمني الذي يتم أخذ التأجير له على عقد إيجار يمثل قسما. إذا لم يتم تجديد عقد الإيجار خلال هذا الفاصل الزمني، فسيتسبب في انتهاء صلاحيته وستنتقل ملكية القسم إلى مثيل آخر. الافتراضي هو 60000 (60 ثانية).
leaseRenewInterval	عند التعيين، فإنه يحدد، بالمللي ثانية، فاصل التجديد لجميع عقود الإيجار للأقسام التي يحتفظ بها مثيل حاليا. الافتراضي هو 17000 (17 ثانية).
leasesContainerThroughput	عند تعيين createLeaseContainerIfNotExists إلى true، يحدد مقدار وحدات الطلب لتعيينها إلى حاوية التأجير التي تم إنشاؤها
maxItemsPerInvocation	عند التعيين، تعين هذه الخاصية الحد الأقصى لعدد العناصر المستلمة لكل استدعاء دالة. إذا تم تنفيذ العمليات في الحاوية المراقبة من خلال الإجراءات المخزنة، يتم الاحتفاظ بالنطاق المعاملة عند قراءة العناصر من موجز التغيير. ونتيجة لذلك، يمكن أن يكون عدد العناصر المستلمة أعلى من القيمة المحددة بحيث يتم إرجاع العناصر التي تم تغييرها بواسطة نفس المعاملة كجزء من دفعة ذرية واحدة.
preferredLocations	تحديد المواقع المفضلة (المناطق) لحسابات قاعدة البيانات المنسوخة جغرافيا في خدمة Azure Cosmos DB. يجب فصل القيم بفواصل. على سبيل المثال، شرق الولايات المتحدة وجنوب وسط الولايات المتحدة وشمال أوروبا
return	تكوين الإخراج الأساسي الاختياري للدالة هذا هو الإخراج الرئيسي الذي يجب تعيينه كقيمة إرجاع لمعالج الدالة أثناء استدعاء
startFromBeginning	يخبر هذا الخيار المشغل بقراءة التغييرات من بداية محفوظات تغيير الحاوية بدلا من البدء في الوقت الحالي. تعمل القراءة من البداية فقط في المرة الأولى التي يبدأ فيها المشغل، كما هو الحال في عمليات التشغيل اللاحقة، يتم تخزين نقاط التحقق بالفعل. تعيين هذا الخيار إلى true عند وجود عقود إيجار تم إنشاؤها بالفعل ليس له أي تأثير.
startFromTime	الحصول على التاريخ والوقت أو تعيينهما لتهيئة عملية قراءة موجز التغيير. التنسيق الموصى به هو ISO 8601 مع المعين UTC، مثل 2021-02-16T14:19:29Z. يتم استخدام هذا فقط لتعيين حالة المشغل الأولي. بعد أن يكون للمشغل حالة تأجير، لا يكون لتغيير هذه القيمة أي تأثير.

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

handler

handler: CosmosDBv4Handler

قيمة الخاصية

CosmosDBv4Handler

retry

نهج إعادة محاولة اختياري لإعادة تشغيل تنفيذ فاشل حتى يحدث إكمال ناجح أو يتم الوصول إلى الحد الأقصى لعدد مرات إعادة المحاولة. تعرف على المزيد هنا

retry?: RetryOptions

قيمة الخاصية

RetryOptions

trigger

trigger?: CosmosDBv4Trigger

قيمة الخاصية

CosmosDBv4Trigger

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

connection

إعداد تطبيق (أو متغير بيئة) مع سلسلة اتصال Cosmos DB

connection: string

قيمة الخاصية

string

موروث منCosmosDBv4TriggerOptions.connection

containerName

اسم الحاوية التي تتم مراقبتها

containerName: string

قيمة الخاصية

string

موروث منCosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

التحقق من وجود وإنشاء حاوية عقود الإيجار تلقائيا. الافتراضي هو false

createLeaseContainerIfNotExists?: boolean

قيمة الخاصية

boolean

موروث منCosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

اسم قاعدة بيانات Azure Cosmos DB مع مراقبة الحاوية

databaseName: string

قيمة الخاصية

string

موروث منCosmosDBv4TriggerOptions.databaseName

extraInputs

تكوين مجموعة اختيارية من المدخلات الثانوية أثناء استدعاء، احصل على هذه القيم مع context.extraInputs.get()

extraInputs?: FunctionInput[]

قيمة الخاصية

FunctionInput[]

موروث من Partial.extraInputs

extraOutputs

تكوين مجموعة اختيارية من المخرجات الثانوية أثناء استدعاء، قم بتعيين هذه القيم مع context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

قيمة الخاصية

FunctionOutput[]

موروث من Partial.extraOutputs

feedPollDelay

الوقت (بالمللي ثانية) للتأخير بين الاستقصاء عن قسم للتغييرات الجديدة على الموجز، بعد استنزاف جميع التغييرات الحالية. الافتراضي هو 5000 مللي ثانية أو 5 ثوان.

feedPollDelay?: number

قيمة الخاصية

number

موروث منCosmosDBv4TriggerOptions.feedPollDelay

leaseAcquireInterval

عند التعيين، فإنه يحدد، بالمللي ثانية، الفاصل الزمني لبدء مهمة لحساب إذا تم توزيع الأقسام بالتساوي بين مثيلات المضيف المعروفة. الافتراضي هو 13000 (13 ثانية).

leaseAcquireInterval?: number

قيمة الخاصية

number

موروث منCosmosDBv4TriggerOptions.leaseAcquireInterval

leaseConnection

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

leaseConnection?: string

قيمة الخاصية

string

موروث منCosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

اسم الحاوية لتخزين عقود الإيجار. إذا لم يتم تعيينه، فسيستخدم "عقود الإيجار"

leaseContainerName?: string

قيمة الخاصية

string

موروث منCosmosDBv4TriggerOptions.leaseContainerName

leaseContainerPrefix

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

leaseContainerPrefix?: string

قيمة الخاصية

string

موروث منCosmosDBv4TriggerOptions.leaseContainerPrefix

leaseDatabaseName

اسم قاعدة البيانات التي تحتوي على الحاوية لتخزين عقود الإيجار. إذا لم يتم تعيينه، فسيستخدم قيمة databaseName

leaseDatabaseName?: string

قيمة الخاصية

string

موروث منCosmosDBv4TriggerOptions.leaseDatabaseName

leaseExpirationInterval

عند التعيين، فإنه يحدد، بالمللي ثانية، الفاصل الزمني الذي يتم أخذ التأجير له على عقد إيجار يمثل قسما. إذا لم يتم تجديد عقد الإيجار خلال هذا الفاصل الزمني، فسيتسبب في انتهاء صلاحيته وستنتقل ملكية القسم إلى مثيل آخر. الافتراضي هو 60000 (60 ثانية).

leaseExpirationInterval?: number

قيمة الخاصية

number

موروث منCosmosDBv4TriggerOptions.leaseExpirationInterval

leaseRenewInterval

عند التعيين، فإنه يحدد، بالمللي ثانية، فاصل التجديد لجميع عقود الإيجار للأقسام التي يحتفظ بها مثيل حاليا. الافتراضي هو 17000 (17 ثانية).

leaseRenewInterval?: number

قيمة الخاصية

number

موروث منCosmosDBv4TriggerOptions.leaseRenewInterval

leasesContainerThroughput

عند تعيين createLeaseContainerIfNotExists إلى true، يحدد مقدار وحدات الطلب لتعيينها إلى حاوية التأجير التي تم إنشاؤها

leasesContainerThroughput?: number

قيمة الخاصية

number

موروث منCosmosDBv4TriggerOptions.leasesContainerThroughput

maxItemsPerInvocation

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

maxItemsPerInvocation?: number

قيمة الخاصية

number

موروث منCosmosDBv4TriggerOptions.maxItemsPerInvocation

preferredLocations

تحديد المواقع المفضلة (المناطق) لحسابات قاعدة البيانات المنسوخة جغرافيا في خدمة Azure Cosmos DB. يجب فصل القيم بفواصل. على سبيل المثال، شرق الولايات المتحدة وجنوب وسط الولايات المتحدة وشمال أوروبا

preferredLocations?: string

قيمة الخاصية

string

موروث منCosmosDBv4TriggerOptions.preferredLocations

return

تكوين الإخراج الأساسي الاختياري للدالة هذا هو الإخراج الرئيسي الذي يجب تعيينه كقيمة إرجاع لمعالج الدالة أثناء استدعاء

return?: FunctionOutput

قيمة الخاصية

FunctionOutput

موروث من Partial.return

startFromBeginning

يخبر هذا الخيار المشغل بقراءة التغييرات من بداية محفوظات تغيير الحاوية بدلا من البدء في الوقت الحالي. تعمل القراءة من البداية فقط في المرة الأولى التي يبدأ فيها المشغل، كما هو الحال في عمليات التشغيل اللاحقة، يتم تخزين نقاط التحقق بالفعل. تعيين هذا الخيار إلى true عند وجود عقود إيجار تم إنشاؤها بالفعل ليس له أي تأثير.

startFromBeginning?: boolean

قيمة الخاصية

boolean

موروث منCosmosDBv4TriggerOptions.startFromBeginning

startFromTime

الحصول على التاريخ والوقت أو تعيينهما لتهيئة عملية قراءة موجز التغيير. التنسيق الموصى به هو ISO 8601 مع المعين UTC، مثل 2021-02-16T14:19:29Z. يتم استخدام هذا فقط لتعيين حالة المشغل الأولي. بعد أن يكون للمشغل حالة تأجير، لا يكون لتغيير هذه القيمة أي تأثير.

startFromTime?: string

قيمة الخاصية

string

موروث منCosmosDBv4TriggerOptions.startFromTime