RuntimeOptions interface

خيارات التكوين لوظيفة قابلة للتطبيق في وقت التشغيل.

إمضاء:

export interface RuntimeOptions

ملكيات

ملكية يكتب وصف
consuméAppCheckToken منطقية يحدد ما إذا كان سيتم استهلاك رمز Firebase App Check المميز عند الطلب. الافتراضيات كاذبة.
forceAppCheck منطقية يحدد ما إذا كان Firebase AppCheck قد تم فرضه أم لا.
سياسة الفشل سياسة الفشل | منطقية سياسة فشل الوظيفة، مع كون القيمة المنطقية true مكافئة لتوفير كائن إعادة محاولة فارغ.
إعدادات الدخول (نوع INGRESS_SETTINGS_OPTIONS )[الرقم] | إعادة تعيين القيمة إعدادات الدخول التي تتحكم في المكان الذي يمكن استدعاء هذه الوظيفة منه.
المستحضر "عامة" | "خاص" | سلسلة | خيط[] المستدعي لتعيين التحكم في الوصول إلى وظائف https.
تسميات سجل <سلسلة، سلسلة> تسميات المستخدم لتعيينها على الوظيفة.
maxInstances رقم | تعبير <رقم> | إعادة تعيين القيمة الحد الأقصى لعدد المثيلات الفعلية المسموح لها بالتشغيل بالتوازي.
ذاكرة (نوع VALID_MEMORY_OPTIONS )[الرقم] | تعبير <رقم> | إعادة تعيين القيمة مقدار الذاكرة المخصصة للوظيفة.
minInstances رقم | تعبير <رقم> | إعادة تعيين القيمة الحد الأدنى لعدد المثيلات الفعلية التي سيتم تشغيلها في وقت معين.
saveExternalChanges منطقية يتحكم في ما إذا كان سيتم الاحتفاظ بتكوين الوظيفة المعدل خارج مصدر الوظيفة. الافتراضيات كاذبة.
أسرار (سلسلة | SecretParam)[]
com.serviceAccount.service "الافتراضي" | سلسلة | تعبير <سلسلة> | إعادة تعيين القيمة حساب خدمة محدد للوظيفة التي سيتم تشغيلها كـ.
timeoutSeconds رقم | تعبير <رقم> | إعادة تعيين القيمة مهلة الوظيفة بالثواني، القيم المحتملة هي من 0 إلى 540.
vpcConnector سلسلة | تعبير <سلسلة> | إعادة تعيين القيمة قم بتوصيل وظيفة السحابة بموصل VPC المحدد.
vpcConnectorEgressSettings (نوع VPC_EGRESS_SETTINGS_OPTIONS )[الرقم] | إعادة تعيين القيمة إعدادات الخروج لموصل VPC.

RuntimeOptions.consumeAppCheckToken

يحدد ما إذا كان سيتم استهلاك رمز Firebase App Check المميز عند الطلب. الافتراضيات كاذبة.

اضبط هذا على "صحيح" لتمكين ميزة حماية إعادة تشغيل التحقق من التطبيق عن طريق استهلاك رمز التحقق من التطبيق عند الطلب القابل للاستدعاء. سيتم تعيين الخاصية request.app.alreadyConsumed على الرموز المميزة التي تم استهلاكها بالفعل على القيمة true.

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

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

لا يؤثر هذا الخيار على خيار enforceAppCheck . سيؤدي تعيين الأخير على "صحيح" إلى استجابة الوظيفة القابلة للاستدعاء تلقائيًا برمز الحالة 401 غير المصرح به عندما يتضمن الطلب رمزًا مميزًا غير صالح للتحقق من التطبيق. عندما يتضمن الطلب رموز التحقق من التطبيق الصالحة ولكن المستهلكة، فلن يتم رفض الطلبات تلقائيًا. بدلاً من ذلك، سيتم تعيين الخاصية request.app.alreadyConsumed إلى true وتمرير التنفيذ إلى رمز المعالج لاتخاذ المزيد من القرارات، مثل طلب فحوصات أمنية إضافية أو رفض الطلب.

إمضاء:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

يحدد ما إذا كان Firebase AppCheck قد تم فرضه أم لا.

عندما يكون هذا صحيحًا، فإن الطلبات التي تحتوي على رموز مميزة غير صالحة تستجيب تلقائيًا بخطأ 401 (غير مصرح به). عند حدوث خطأ، تقوم الطلبات التي تحتوي على رموز غير صالحة بتعيين context.app على عدم التحديد.

إمضاء:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

سياسة فشل الوظيفة، مع كون القيمة المنطقية true مكافئة لتوفير كائن إعادة محاولة فارغ.

إمضاء:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

إعدادات الدخول التي تتحكم في المكان الذي يمكن استدعاء هذه الوظيفة منه.

إمضاء:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invocer

المستدعي لتعيين التحكم في الوصول إلى وظائف https.

إمضاء:

invoker?: "public" | "private" | string | string[];

RuntimeOptions.labels

تسميات المستخدم لتعيينها على الوظيفة.

إمضاء:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

الحد الأقصى لعدد المثيلات الفعلية المسموح لها بالتشغيل بالتوازي.

إمضاء:

maxInstances?: number | Expression<number> | ResetValue;

RuntimeOptions.memory

مقدار الذاكرة المخصصة للوظيفة.

إمضاء:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

الحد الأدنى لعدد المثيلات الفعلية التي سيتم تشغيلها في وقت معين.

سيتم فرض رسوم على المثيلات مقابل تخصيص الذاكرة و10% من تخصيص وحدة المعالجة المركزية أثناء الخمول.

إمضاء:

minInstances?: number | Expression<number> | ResetValue;

RuntimeOptions.preserveExternalChanges

يتحكم في ما إذا كان سيتم الاحتفاظ بتكوين الوظيفة المعدل خارج مصدر الوظيفة. الافتراضيات كاذبة.

عند تعيين التكوين المتاح في النظام الأساسي الأساسي الذي لم يتوفر بعد في Firebase Functions SDK، نوصي بشدة بتعيين preserveExternalChanges على true . بخلاف ذلك، عندما تقوم Firebase Functions SDK بإصدار إصدار جديد من SDK مع دعم التكوين المفقود، فقد يتم مسح الإعداد الذي تم تكوينه يدويًا لوظيفتك عن غير قصد.

إمضاء:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

إمضاء:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

حساب خدمة محدد للوظيفة التي سيتم تشغيلها كـ.

إمضاء:

serviceAccount?: "default" | string | Expression<string> | ResetValue;

RuntimeOptions.timeoutSeconds

مهلة الوظيفة بالثواني، القيم المحتملة هي من 0 إلى 540.

إمضاء:

timeoutSeconds?: number | Expression<number> | ResetValue;

RuntimeOptions.vpcConnector

قم بتوصيل وظيفة السحابة بموصل VPC المحدد.

إمضاء:

vpcConnector?: string | Expression<string> | ResetValue;

RuntimeOptions.vpcConnectorEgressSettings

إعدادات الخروج لموصل VPC.

إمضاء:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;
,

خيارات التكوين لوظيفة قابلة للتطبيق في وقت التشغيل.

إمضاء:

export interface RuntimeOptions

ملكيات

ملكية يكتب وصف
consuméAppCheckToken منطقية يحدد ما إذا كان سيتم استهلاك رمز Firebase App Check المميز عند الطلب. الافتراضيات كاذبة.
forceAppCheck منطقية يحدد ما إذا كان Firebase AppCheck قد تم فرضه أم لا.
سياسة الفشل سياسة الفشل | منطقية سياسة فشل الوظيفة، مع كون القيمة المنطقية true مكافئة لتوفير كائن إعادة محاولة فارغ.
إعدادات الدخول (نوع INGRESS_SETTINGS_OPTIONS )[الرقم] | إعادة تعيين القيمة إعدادات الدخول التي تتحكم في المكان الذي يمكن استدعاء هذه الوظيفة منه.
المستحضر "عامة" | "خاص" | سلسلة | خيط[] المستدعي لتعيين التحكم في الوصول إلى وظائف https.
تسميات سجل <سلسلة، سلسلة> تسميات المستخدم لتعيينها على الوظيفة.
maxInstances رقم | تعبير <رقم> | إعادة تعيين القيمة الحد الأقصى لعدد المثيلات الفعلية المسموح لها بالتشغيل بالتوازي.
ذاكرة (نوع VALID_MEMORY_OPTIONS )[الرقم] | تعبير <رقم> | إعادة تعيين القيمة مقدار الذاكرة المخصصة للوظيفة.
minInstances رقم | تعبير <رقم> | إعادة تعيين القيمة الحد الأدنى لعدد المثيلات الفعلية التي سيتم تشغيلها في وقت معين.
saveExternalChanges منطقية يتحكم في ما إذا كان سيتم الاحتفاظ بتكوين الوظيفة المعدل خارج مصدر الوظيفة. الافتراضيات كاذبة.
أسرار (سلسلة | SecretParam)[]
com.serviceAccount.service "الافتراضي" | سلسلة | تعبير <سلسلة> | إعادة تعيين القيمة حساب خدمة محدد للوظيفة التي سيتم تشغيلها كـ.
timeoutSeconds رقم | تعبير <رقم> | إعادة تعيين القيمة مهلة الوظيفة بالثواني، القيم المحتملة هي من 0 إلى 540.
vpcConnector سلسلة | تعبير <سلسلة> | إعادة تعيين القيمة قم بتوصيل وظيفة السحابة بموصل VPC المحدد.
vpcConnectorEgressSettings (نوع VPC_EGRESS_SETTINGS_OPTIONS )[الرقم] | إعادة تعيين القيمة إعدادات الخروج لموصل VPC.

RuntimeOptions.consumeAppCheckToken

يحدد ما إذا كان سيتم استهلاك رمز Firebase App Check المميز عند الطلب. الافتراضيات كاذبة.

اضبط هذا على "صحيح" لتمكين ميزة حماية إعادة تشغيل التحقق من التطبيق عن طريق استهلاك رمز التحقق من التطبيق عند الطلب القابل للاستدعاء. سيتم تعيين الخاصية request.app.alreadyConsumed على الرموز المميزة التي تم استهلاكها بالفعل على القيمة true.

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

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

لا يؤثر هذا الخيار على خيار enforceAppCheck . سيؤدي تعيين الأخير على "صحيح" إلى استجابة الوظيفة القابلة للاستدعاء تلقائيًا برمز الحالة 401 غير المصرح به عندما يتضمن الطلب رمزًا مميزًا غير صالح للتحقق من التطبيق. عندما يتضمن الطلب رموز التحقق من التطبيق الصالحة ولكن المستهلكة، فلن يتم رفض الطلبات تلقائيًا. بدلاً من ذلك، سيتم تعيين الخاصية request.app.alreadyConsumed إلى true وتمرير التنفيذ إلى رمز المعالج لاتخاذ المزيد من القرارات، مثل طلب فحوصات أمنية إضافية أو رفض الطلب.

إمضاء:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

يحدد ما إذا كان Firebase AppCheck قد تم فرضه أم لا.

عندما يكون هذا صحيحًا، فإن الطلبات التي تحتوي على رموز مميزة غير صالحة تستجيب تلقائيًا بخطأ 401 (غير مصرح به). عند حدوث خطأ، تقوم الطلبات التي تحتوي على رموز غير صالحة بتعيين context.app على عدم التحديد.

إمضاء:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

سياسة فشل الوظيفة، مع كون القيمة المنطقية true مكافئة لتوفير كائن إعادة محاولة فارغ.

إمضاء:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

إعدادات الدخول التي تتحكم في المكان الذي يمكن استدعاء هذه الوظيفة منه.

إمضاء:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invocer

المستدعي لتعيين التحكم في الوصول إلى وظائف https.

إمضاء:

invoker?: "public" | "private" | string | string[];

RuntimeOptions.labels

تسميات المستخدم لتعيينها على الوظيفة.

إمضاء:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

الحد الأقصى لعدد المثيلات الفعلية المسموح لها بالتشغيل بالتوازي.

إمضاء:

maxInstances?: number | Expression<number> | ResetValue;

RuntimeOptions.memory

مقدار الذاكرة المخصصة للوظيفة.

إمضاء:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

الحد الأدنى لعدد المثيلات الفعلية التي سيتم تشغيلها في وقت معين.

سيتم فرض رسوم على المثيلات مقابل تخصيص الذاكرة و10% من تخصيص وحدة المعالجة المركزية أثناء الخمول.

إمضاء:

minInstances?: number | Expression<number> | ResetValue;

RuntimeOptions.preserveExternalChanges

يتحكم في ما إذا كان سيتم الاحتفاظ بتكوين الوظيفة المعدل خارج مصدر الوظيفة. الافتراضيات كاذبة.

عند تعيين التكوين المتاح في النظام الأساسي الأساسي الذي لم يتوفر بعد في Firebase Functions SDK، نوصي بشدة بتعيين preserveExternalChanges على true . بخلاف ذلك، عندما تقوم Firebase Functions SDK بإصدار إصدار جديد من SDK مع دعم التكوين المفقود، فقد يتم مسح الإعداد الذي تم تكوينه يدويًا لوظيفتك عن غير قصد.

إمضاء:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

إمضاء:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

حساب خدمة محدد للوظيفة التي سيتم تشغيلها كـ.

إمضاء:

serviceAccount?: "default" | string | Expression<string> | ResetValue;

RuntimeOptions.timeoutSeconds

مهلة الوظيفة بالثواني، القيم المحتملة هي من 0 إلى 540.

إمضاء:

timeoutSeconds?: number | Expression<number> | ResetValue;

RuntimeOptions.vpcConnector

قم بتوصيل وظيفة السحابة بموصل VPC المحدد.

إمضاء:

vpcConnector?: string | Expression<string> | ResetValue;

RuntimeOptions.vpcConnectorEgressSettings

إعدادات الخروج لموصل VPC.

إمضاء:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;