ממשק שירות Firebase SecurityRules .
חֲתִימָה:
export declare class SecurityRules
נכסים
| תכונה | משנה | סוּג | תיאור |
|---|---|---|---|
| אפליקציה | אפליקציה |
שיטות
| שיטה | משנה | תיאור |
|---|---|---|
| createRuleset(קובץ) | יוצר ערכת כללים חדשה מתוך RulesFile הנתון . | |
| createRulesFileFromSource(שם, מקור) | יוצר RulesFile עם השם והמקור הנתונים. זורק שגיאה אם אחד מהארגומנטים אינו חוקי. זוהי פעולה מקומית, ואינה כרוכה בקריאות API לרשת. | |
| deleteRuleset(שם) | מוחק את ערכת החוקים המזוהה בשם הנתונים. שם הקלט צריך להיות מחרוזת השם הקצר ללא קידומת מזהה הפרויקט. לדוגמה, כדי למחוק את projects/project-id/rulesets/my-ruleset , העבר את השם הקצר "ערכת הכללים שלי". דוחה עם שגיאה not-found אם לא ניתן למצוא את Ruleset שצוינה. | |
| getFirestoreRuleset() | מקבל את ערכת הכללים המוחלת כעת על Cloud Firestore. דוחה עם שגיאה not-found אם לא מוחל ערכת כללים ב-Firestore. | |
| getRuleset(שם) | מקבל את ערכת החוקים המזוהה בשם הנתונים. שם הקלט צריך להיות מחרוזת השם הקצר ללא קידומת מזהה הפרויקט. לדוגמה, כדי לאחזר את projects/project-id/rulesets/my-ruleset , העבר את השם הקצר "ערכת הכללים שלי". דוחה עם שגיאה not-found אם לא ניתן למצוא את Ruleset שצוינה. | |
| getStorageRuleset(bucket) | מקבל את ערכת הכללים המוחלת כעת על דלי של Cloud Storage. דוחה עם שגיאה not-found אם לא הוחל ערכת כללים על הדלי. | |
| listRulesetMetadata(עמוד Size, NextPageToken) | מאחזר עמוד של מטא נתונים של ערכת כללים. | |
| releaseFirestoreRuleset(ruleset) | מחיל את ערכת הכללים שצוינה על Cloud Firestore. | |
| releaseFirestoreRulesetFromSource(source) | יוצר ערכת חוקים חדשה מהמקור הנתון, ומחיל אותה על Cloud Firestore. | |
| releaseStorageRuleset(ערכת כללים, דלי) | מחיל את ערכת הכללים שצוינה על דלי של Cloud Storage. | |
| releaseStorageRulesetFromSource(מקור, דלי) | יוצר ערכת חוקים חדשה מהמקור הנתון, ומחיל אותה על דלי של Cloud Storage. |
SecurityRules.app
חֲתִימָה:
readonly app: App;
SecurityRules.createRuleset()
יוצר ערכת כללים חדשה מתוך RulesFile הנתון .
חֲתִימָה:
createRuleset(file: RulesFile): Promise<Ruleset>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| קוֹבֶץ | RulesFile | קובץ כללים שיש לכלול בערכת Ruleset החדשה. |
החזרות:
הבטחה< סט חוקים >
הבטחה שמתממשת עם Ruleset החדשה שנוצרה .
SecurityRules.createRulesFileFromSource()
יוצר RulesFile עם השם והמקור הנתונים. זורק שגיאה אם אחד מהארגומנטים אינו חוקי. זוהי פעולה מקומית, ואינה כרוכה בקריאות API לרשת.
חֲתִימָה:
createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| שֵׁם | חוּט | שם להקצאה לקובץ הכללים. זה בדרך כלל שם קובץ קצר שעוזר לזהות את הקובץ בערכת כללים. |
| מָקוֹר | מחרוזת | בַּלָם | תוכן קובץ הכללים. |
החזרות:
מופע קובץ חוקים חדש.
דוגמא
const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
'firestore.rules', source);
SecurityRules.deleteRuleset()
מוחק את ערכת החוקים המזוהה בשם הנתונים. שם הקלט צריך להיות מחרוזת השם הקצר ללא קידומת מזהה הפרויקט. לדוגמה, כדי למחוק את projects/project-id/rulesets/my-ruleset , העבר את השם הקצר "סט הכללים שלי". דוחה עם שגיאה not-found אם לא ניתן למצוא את Ruleset שצוינה.
חֲתִימָה:
deleteRuleset(name: string): Promise<void>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| שֵׁם | חוּט | שם ערכת Ruleset שיש למחוק. |
החזרות:
הבטחה<void>
הבטחה שמתקיימת כאשר Ruleset נמחקת.
SecurityRules.getFirestoreRuleset()
מקבל את ערכת הכללים המוחלת כעת על Cloud Firestore. דוחה עם שגיאה not-found אם לא מוחל ערכת כללים ב-Firestore.
חֲתִימָה:
getFirestoreRuleset(): Promise<Ruleset>;
החזרות:
הבטחה< סט חוקים >
הבטחה שמתממשת עם ערכת החוקים של Firestore.
SecurityRules.getRuleset()
מקבל את ערכת החוקים המזוהה בשם הנתונים. שם הקלט צריך להיות מחרוזת השם הקצר ללא קידומת מזהה הפרויקט. לדוגמה, כדי לאחזר את projects/project-id/rulesets/my-ruleset , העבר את השם הקצר "סט הכללים שלי". דוחה עם שגיאה not-found אם לא ניתן למצוא את Ruleset שצוינה.
חֲתִימָה:
getRuleset(name: string): Promise<Ruleset>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| שֵׁם | חוּט | שם ערכת Ruleset שיש לאחזר. |
החזרות:
הבטחה< סט חוקים >
הבטחה שמתקיימת עם Ruleset שצוינה .
SecurityRules.getStorageRuleset()
מקבל את ערכת הכללים המוחלת כעת על דלי של Cloud Storage. דוחה עם שגיאה not-found אם לא הוחל ערכת כללים על הדלי.
חֲתִימָה:
getStorageRuleset(bucket?: string): Promise<Ruleset>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| דְלִי | חוּט | שם אופציונלי של דלי Cloud Storage שיש לאחזר. אם לא צוין, מאחזר את ערכת הכללים שהוחלה על דלי ברירת המחדל שהוגדר באמצעות AppOptions . |
החזרות:
הבטחה< סט חוקים >
הבטחה שמתממשת עם ערכת הכללים של Cloud Storage.
SecurityRules.listRulesetMetadata()
מאחזר עמוד של מטא נתונים של ערכת כללים.
חֲתִימָה:
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| גודל עמוד | מספר | גודל העמוד, 100 אם לא מוגדר. זהו גם הגבול המרבי המותר. |
| nextPageToken | חוּט | אסימון העמוד הבא. אם לא צוין, מחזיר ערכות כללים שמתחילות ללא כל היסט. |
החזרות:
הבטחה< RulesetMetadataList >
הבטחה שמתממשת עם דף של ערכי חוקים.
SecurityRules.releaseFirestoreRuleset()
מחיל את ערכת הכללים שצוינה על Cloud Firestore.
חֲתִימָה:
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| ערכת כללים | מחרוזת | RulesetMetadata | שם ערכת הכללים שיש להחיל או אובייקט RulesetMetadata המכיל את השם. |
החזרות:
הבטחה<void>
הבטחה שמתממשת כאשר ערכת החוקים משתחררת.
SecurityRules.releaseFirestoreRulesetFromSource()
יוצר ערכת חוקים חדשה מהמקור הנתון, ומחיל אותה על Cloud Firestore.
חֲתִימָה:
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מָקוֹר | מחרוזת | בַּלָם | מקור כללים ליישום. |
החזרות:
הבטחה< סט חוקים >
הבטחה שמתממשת כאשר מערכת הכללים נוצרת ומשתחררת.
SecurityRules.releaseStorageRuleset()
מחיל את ערכת הכללים שצוינה על דלי של Cloud Storage.
חֲתִימָה:
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| ערכת כללים | מחרוזת | RulesetMetadata | שם ערכת הכללים שיש להחיל או אובייקט RulesetMetadata המכיל את השם. |
| דְלִי | חוּט | שם אופציונלי של דלי Cloud Storage להחיל את הכללים עליו. אם לא צוין, החל את ערכת הכללים על דלי ברירת המחדל שהוגדר באמצעות AppOptions . |
החזרות:
הבטחה<void>
הבטחה שמתממשת כאשר ערכת החוקים משתחררת.
SecurityRules.releaseStorageRulesetFromSource()
יוצר ערכת חוקים חדשה מהמקור הנתון, ומחיל אותה על דלי של Cloud Storage.
חֲתִימָה:
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מָקוֹר | מחרוזת | בַּלָם | מקור כללים ליישום. |
| דְלִי | חוּט | שם אופציונלי של דלי Cloud Storage להחיל את הכללים עליו. אם לא צוין, החל את ערכת הכללים על דלי ברירת המחדל שהוגדר באמצעות AppOptions . |
החזרות:
הבטחה< סט חוקים >
הבטחה שמתממשת כאשר מערכת הכללים נוצרת ומשתחררת.