SecurityRules class

ממשק שירות Firebase SecurityRules .

חֲתִימָה:

export declare class SecurityRules 

נכסים

שיטות

SecurityRules.app

חֲתִימָה:

readonly app: App;

SecurityRules.createRuleset()

יוצר ערכת כללים חדשה מתוך RulesFile הנתון .

חֲתִימָה:

createRuleset(file: RulesFile): Promise<Ruleset>;

פרמטרים

החזרות:

הבטחה< סט חוקים >

הבטחה שמתממשת עם Ruleset החדשה שנוצרה .

SecurityRules.createRulesFileFromSource()

יוצר RulesFile עם השם והמקור הנתונים. זורק שגיאה אם ​​אחד מהארגומנטים אינו חוקי. זוהי פעולה מקומית, ואינה כרוכה בקריאות API לרשת.

חֲתִימָה:

createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;

פרמטרים

החזרות:

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>;

פרמטרים

החזרות:

הבטחה<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 שצוינה .

SecurityRules.getStorageRuleset()

מקבל את ערכת הכללים המוחלת כעת על דלי של Cloud Storage. דוחה עם שגיאה not-found אם ​​לא הוחל ערכת כללים על הדלי.

חֲתִימָה:

getStorageRuleset(bucket?: string): Promise<Ruleset>;

פרמטרים

החזרות:

הבטחה< סט חוקים >

הבטחה שמתממשת עם ערכת הכללים של Cloud Storage.

SecurityRules.listRulesetMetadata()

מאחזר עמוד של מטא נתונים של ערכת כללים.

חֲתִימָה:

listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;

פרמטרים

החזרות:

הבטחה< RulesetMetadataList >

הבטחה שמתממשת עם דף של ערכי חוקים.

SecurityRules.releaseFirestoreRuleset()

מחיל את ערכת הכללים שצוינה על Cloud Firestore.

חֲתִימָה:

releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;

פרמטרים

החזרות:

הבטחה<void>

הבטחה שמתממשת כאשר ערכת החוקים משתחררת.

SecurityRules.releaseFirestoreRulesetFromSource()

יוצר ערכת חוקים חדשה מהמקור הנתון, ומחיל אותה על Cloud Firestore.

חֲתִימָה:

releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;

פרמטרים

החזרות:

הבטחה< סט חוקים >

הבטחה שמתממשת כאשר מערכת הכללים נוצרת ומשתחררת.

SecurityRules.releaseStorageRuleset()

מחיל את ערכת הכללים שצוינה על דלי של Cloud Storage.

חֲתִימָה:

releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;

פרמטרים

החזרות:

הבטחה<void>

הבטחה שמתממשת כאשר ערכת החוקים משתחררת.

SecurityRules.releaseStorageRulesetFromSource()

יוצר ערכת חוקים חדשה מהמקור הנתון, ומחיל אותה על דלי של Cloud Storage.

חֲתִימָה:

releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;

פרמטרים

החזרות:

הבטחה< סט חוקים >

הבטחה שמתממשת כאשר מערכת הכללים נוצרת ומשתחררת.