RuntimeOptions interface

گزینه های پیکربندی برای عملکردی که در زمان اجرا قابل اجرا است.

امضا:

export interface RuntimeOptions

خواص

ویژگی تایپ کنید شرح
ConsumeAppCheckToken بولی تعیین می کند که آیا نشانه Firebase App Check در صورت درخواست مصرف می شود یا خیر. پیش فرض به نادرست.
EnforceAppCheck بولی تعیین می کند که آیا Firebase AppCheck اجرا می شود یا خیر.
سیاست شکست سیاست شکست | بولی خط مشی شکست تابع، با true بولی که معادل ارائه یک شی دوباره خالی است.
ingress Settings (نوع INGRESS_SETTINGS_OPTIONS )[شماره] | ResetValue تنظیمات ورودی که کنترل می کنند این تابع از کجا می تواند فراخوانی شود.
فراخوان "عمومی" | "خصوصی" | رشته | رشته[] Invoker برای تنظیم کنترل دسترسی روی توابع https.
برچسب ها ضبط <رشته، رشته> برچسب های کاربر برای تنظیم روی عملکرد.
maxInstances شماره | اصطلاح <تعداد> | ResetValue حداکثر تعداد نمونه های واقعی مجاز به اجرای موازی.
حافظه (نوع VALID_MEMORY_OPTIONS )[شماره] | اصطلاح <تعداد> | ResetValue مقدار حافظه برای تخصیص به تابع.
موارد min شماره | اصطلاح <تعداد> | ResetValue حداقل تعداد نمونه های واقعی برای اجرا در یک زمان معین.
حفظ تغییرات خارجی بولی کنترل می کند که آیا پیکربندی عملکرد اصلاح شده خارج از منبع تابع حفظ شود یا خیر. پیش فرض به نادرست.
اسرار (رشته | SecretParam)[]
حساب سرویس "پیش فرض" | رشته | اصطلاح <رشته> | ResetValue حساب سرویس خاص برای اجرای تابع به عنوان.
تایم اوت ثانیه شماره | اصطلاح <تعداد> | ResetValue وقفه برای تابع در ثانیه، مقادیر ممکن 0 تا 540 است.
vpcConnector رشته | اصطلاح <رشته> | ResetValue عملکرد ابر را به کانکتور VPC مشخص وصل کنید.
vpcConnectorEgressSettings (نوع VPC_EGRESS_SETTINGS_OPTIONS )[شماره] | ResetValue تنظیمات خروجی برای اتصال VPC.

RuntimeOptions.consumeAppCheckToken

تعیین می کند که آیا نشانه Firebase App Check در صورت درخواست مصرف می شود یا خیر. پیش فرض به نادرست.

این را روی true تنظیم کنید تا با استفاده از نشانه App Check در صورت درخواست قابل فراخوان، ویژگی محافظت از پخش مجدد App Check را فعال کنید. توکن‌هایی که مشخص شد قبلاً مصرف شده‌اند دارای ویژگی request.app.alreadyConsumed روی true تنظیم می‌شوند.

توکن‌ها تنها در صورتی مصرف‌شده در نظر گرفته می‌شوند که با تنظیم این گزینه روی true به سرویس App Check ارسال شوند. استفاده های دیگر از توکن آن را مصرف نمی کند.

این ویژگی محافظت از پخش مجدد نیاز به یک تماس شبکه اضافی با App Check دارد و مشتریان را مجبور می‌کند تا یک گواهی جدید از ارائه‌دهندگان گواهی انتخابی دریافت کنند. بنابراین، این می تواند بر عملکرد تأثیر منفی بگذارد و به طور بالقوه می تواند سهمیه ارائه دهندگان گواهینامه شما را سریعتر کاهش دهد. از این ویژگی فقط برای محافظت از عملیات های کم حجم، حیاتی امنیتی یا گران قیمت استفاده کنید.

این گزینه روی گزینه enforceAppCheck تاثیری ندارد. تنظیم دومی روی true باعث می شود که عملکرد قابل فراخوانی به طور خودکار با یک کد وضعیت غیرمجاز 401 پاسخ دهد زمانی که درخواست شامل یک رمز برنامه نامعتبر باشد. وقتی درخواست شامل نشانه‌های معتبر اما مصرف‌شده App Check باشد، درخواست‌ها به‌طور خودکار رد نمی‌شوند. درعوض، ویژگی request.app.alreadyConsumed روی true تنظیم می‌شود و برای تصمیم‌گیری‌های بیشتر، مانند نیاز به بررسی‌های امنیتی اضافی یا رد درخواست، اجرا را به کد کنترل‌کننده منتقل می‌کند.

امضا:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

تعیین می کند که آیا Firebase AppCheck اجرا می شود یا خیر.

وقتی درست است، درخواست‌هایی با نشانه‌های نامعتبر با خطای 401 (غیر مجاز) پاسخ می‌دهند. وقتی نادرست است، درخواست‌های دارای نشانه‌های نامعتبر، context.app را به حالت undefiend تنظیم می‌کنند.

امضا:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

خط مشی شکست تابع، با true بولی که معادل ارائه یک شی دوباره خالی است.

امضا:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

تنظیمات ورودی که کنترل می کنند این تابع از کجا می تواند فراخوانی شود.

امضا:

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

RuntimeOptions.invoker

Invoker برای تنظیم کنترل دسترسی روی توابع 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 درصد از تخصیص CPU در حالت غیرفعال دریافت می‌شود.

امضا:

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;