RuntimeOptions interface

אפשרויות תצורה עבור פונקציה הרלוונטית בזמן ריצה.

חֲתִימָה:

export interface RuntimeOptions

נכסים

תכונה סוּג תיאור
consumeAppCheckToken בוליאני קובע אם Firebase App Check token נצרך לפי בקשה. ברירת המחדל ל-false.
לאכוף את AppCheck בוליאני קובע אם Firebase AppCheck נאכף.
מדיניות כישלון FailurePolicy | בוליאני מדיניות כשל של הפונקציה, כאשר true בוליאני שווה ערך לספק אובייקט ניסיון חוזר ריק.
ingressSettings (סוג של INGRESS_SETTINGS_OPTIONS )[מספר] | ResetValue הגדרות כניסה השולטות מאיפה ניתן לקרוא לפונקציה זו.
מפעיל "ציבורי" | "פרטי" | מחרוזת | חוּט[] Invoker כדי להגדיר בקרת גישה בפונקציות https.
תוויות הקלט<string, string> תוויות משתמש להגדרה בפונקציה.
maxInstances מספר | ביטוי <מספר> | ResetValue המספר המרבי של מופעים בפועל המותר לפעול במקביל.
זיכרון (סוג של VALID_MEMORY_OPTIONS )[מספר] | ביטוי <מספר> | ResetValue כמות הזיכרון להקצאה לפונקציה.
minInstances מספר | ביטוי <מספר> | ResetValue מספר מינימלי של מופעים בפועל שיפעלו בזמן נתון.
לשמורExternalChanges בוליאני שולט אם תצורת הפונקציה ששונתה מחוץ למקור הפונקציה תישמר. ברירת המחדל ל-false.
סודות (מחרוזת | SecretParam)[]
חשבון שירות "ברירת מחדל" | מחרוזת | ביטוי <string> | ResetValue חשבון שירות ספציפי עבור הפונקציה שבה תפעל.
פסק זמן שניות מספר | ביטוי <מספר> | ResetValue הזמן הקצוב לפונקציה בשניות, הערכים האפשריים הם 0 עד 540.
vpcConnector מחרוזת | ביטוי <string> | ResetValue חבר את פונקציית הענן למחבר VPC שצוין.
vpcConnectorEgressSettings (סוג של VPC_EGRESS_SETTINGS_OPTIONS )[מספר] | ResetValue הגדרות יציאה למחבר VPC.

RuntimeOptions.consumeAppCheckToken

קובע אם Firebase App Check token נצרך לפי בקשה. ברירת המחדל ל-false.

הגדר את זה ל-true כדי להפעיל את תכונת ההגנה על הפעלה חוזרת של App Check על ידי צריכת אסימון App Check על פי בקשה שניתן להתקשר. לאסימונים שנמצאו כבר נצרכים, המאפיין request.app.alreadyConsumed מוגדר כ-true.

אסימונים נחשבים לצרוכים רק אם הם נשלחים לשירות App Check על ידי הגדרת אפשרות זו כ-true. שימושים אחרים של האסימון אינם צורכים אותו.

תכונת ההגנה על השמעה חוזרת זו דורשת שיחת רשת נוספת ל-App Check-end ומאלצת את הלקוחות לקבל אישור חדש מספקי האישורים הנבחרים. לכן זה יכול להשפיע לרעה על הביצועים ועלול לרוקן את המכסות של ספקי האישורים שלך מהר יותר. השתמש בתכונה זו רק להגנה על נפח נמוך, פעולות אבטחה קריטיות או יקרות.

אפשרות זו אינה משפיעה על אפשרות enforceAppCheck . הגדרת האחרון כ-true תגרום לפונקציה הניתנת להתקשרות להגיב אוטומטית עם קוד סטטוס 401 לא מורשה כאשר הבקשה כוללת אסימון App Check לא חוקי. כאשר הבקשה כוללת אסימוני 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

שולט אם תצורת הפונקציה ששונתה מחוץ למקור הפונקציה תישמר. ברירת המחדל ל-false.

כאשר מגדירים תצורה זמינה בפלטפורמה הבסיסית שעדיין אינה זמינה ב-Firebase Functions SDK, אנו ממליצים מאוד להגדיר את preserveExternalChanges ל- true . אחרת, כאשר ה-SDK של Firebase Functions משחרר גרסה חדשה של ה-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

נכסים

תכונה סוּג תיאור
consumeAppCheckToken בוליאני קובע אם Firebase App Check token נצרך לפי בקשה. ברירת המחדל ל-false.
לאכוף את AppCheck בוליאני קובע אם Firebase AppCheck נאכף.
מדיניות כישלון FailurePolicy | בוליאני מדיניות כשל של הפונקציה, כאשר true בוליאני שווה ערך לספק אובייקט ניסיון חוזר ריק.
ingressSettings (סוג של INGRESS_SETTINGS_OPTIONS )[מספר] | ResetValue הגדרות כניסה השולטות מאיפה ניתן לקרוא לפונקציה זו.
מפעיל "ציבורי" | "פרטי" | מחרוזת | חוּט[] Invoker כדי להגדיר בקרת גישה בפונקציות https.
תוויות הקלט<string, string> תוויות משתמש להגדרה בפונקציה.
maxInstances מספר | ביטוי <מספר> | ResetValue המספר המרבי של מופעים בפועל המותר לפעול במקביל.
זיכרון (סוג של VALID_MEMORY_OPTIONS )[מספר] | ביטוי <מספר> | ResetValue כמות הזיכרון להקצאה לפונקציה.
minInstances מספר | ביטוי <מספר> | ResetValue מספר מינימלי של מופעים בפועל שיפעלו בזמן נתון.
לשמורExternalChanges בוליאני שולט אם תצורת הפונקציה ששונתה מחוץ למקור הפונקציה תישמר. ברירת המחדל ל-false.
סודות (מחרוזת | SecretParam)[]
חשבון שירות "ברירת מחדל" | מחרוזת | ביטוי <string> | ResetValue חשבון שירות ספציפי עבור הפונקציה שבה תפעל.
פסק זמן שניות מספר | ביטוי <מספר> | ResetValue הזמן הקצוב לפונקציה בשניות, הערכים האפשריים הם 0 עד 540.
vpcConnector מחרוזת | ביטוי <string> | ResetValue חבר את פונקציית הענן למחבר VPC שצוין.
vpcConnectorEgressSettings (סוג של VPC_EGRESS_SETTINGS_OPTIONS )[מספר] | ResetValue הגדרות יציאה למחבר VPC.

RuntimeOptions.consumeAppCheckToken

קובע אם Firebase App Check token נצרך לפי בקשה. ברירת המחדל ל-false.

הגדר את זה ל-true כדי להפעיל את תכונת ההגנה על הפעלה חוזרת של App Check על ידי צריכת אסימון App Check על פי בקשה שניתן להתקשר. לאסימונים שנמצאו כבר נצרכים, המאפיין request.app.alreadyConsumed מוגדר כ-true.

אסימונים נחשבים לצרוכים רק אם הם נשלחים לשירות App Check על ידי הגדרת אפשרות זו כ-true. שימושים אחרים של האסימון אינם צורכים אותו.

תכונת ההגנה על השמעה חוזרת זו דורשת שיחת רשת נוספת ל-App Check-end ומאלצת את הלקוחות לקבל אישור חדש מספקי האישורים הנבחרים. לכן זה יכול להשפיע לרעה על הביצועים ועלול לרוקן את המכסות של ספקי האישורים שלך מהר יותר. השתמש בתכונה זו רק להגנה על נפח נמוך, פעולות אבטחה קריטיות או יקרות.

אפשרות זו אינה משפיעה על אפשרות enforceAppCheck . הגדרת האחרון כ-true תגרום לפונקציה הניתנת להתקשרות להגיב אוטומטית עם קוד סטטוס 401 לא מורשה כאשר הבקשה כוללת אסימון App Check לא חוקי. כאשר הבקשה כוללת אסימוני 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

שולט אם תצורת הפונקציה ששונתה מחוץ למקור הפונקציה תישמר. ברירת המחדל ל-false.

כאשר מגדירים תצורה זמינה בפלטפורמה הבסיסית שעדיין אינה זמינה ב-Firebase Functions SDK, אנו ממליצים מאוד להגדיר את preserveExternalChanges ל- true . אחרת, כאשר ה-SDK של Firebase Functions משחרר גרסה חדשה של ה-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;