SecurityRules class

อินเทอร์เฟซบริการ Firebase SecurityRules

ลายเซ็น:

export declare class SecurityRules 

พร็อพเพอร์ตี้

เมธอด

SecurityRule.app

ลายเซ็น:

readonly app: App;

SecurityRule.createRuleset()

สร้าง Ruleset ใหม่จาก RulesFile ที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

การคืนสินค้า:

สัญญา<Ruleset>

คำมั่นสัญญาที่จะเติมเต็มด้วย Ruleset ที่สร้างขึ้นใหม่

SecurityRule.createRulesFileFromSource()

สร้าง RuleFile โดยใช้ชื่อและแหล่งที่มาที่ระบุ และจะแสดงข้อผิดพลาดหากมีอาร์กิวเมนต์ใดไม่ถูกต้อง นี่คือการดำเนินการภายในและไม่เกี่ยวข้องกับการเรียก API เครือข่ายใดๆ

ลายเซ็น:

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

พารามิเตอร์

การคืนสินค้า:

ไฟล์กฎ

อินสแตนซ์ไฟล์กฎใหม่

ตัวอย่าง

const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
  'firestore.rules', source);

SecurityRule.deleteRuleset()

ลบชุดกฎที่ระบุโดยชื่อตัวนั้นๆ ชื่ออินพุตควรเป็นสตริงชื่อย่อโดยไม่มีคำนำหน้ารหัสโปรเจ็กต์ เช่น หากต้องการลบ projects/project-id/rulesets/my-ruleset ให้ส่งชื่อย่อว่า "my-ruleset" ปฏิเสธโดยมีข้อผิดพลาด not-found หากไม่พบ Ruleset ที่ระบุ

ลายเซ็น:

deleteRuleset(name: string): Promise<void>;

พารามิเตอร์

การคืนสินค้า:

คำสัญญา<โมฆะ>

คำสัญญาที่จะทำตามได้เมื่อลบ Ruleset

SecurityRule.getFirestoreRuleset()

รับ Ruleset ที่ใช้กับ Cloud Firestore ในขณะนี้ ปฏิเสธโดยมีข้อผิดพลาด not-found หากไม่มีการใช้ชุดกฎใน Firestore

ลายเซ็น:

getFirestoreRuleset(): Promise<Ruleset>;

การคืนสินค้า:

สัญญา<Ruleset>

คำมั่นสัญญาที่บรรลุผลได้ด้วยชุดกฎ Firestore

SecurityRules.getRuleset()

รับชุดกฎที่ระบุตามชื่อที่ต้องการ ชื่ออินพุตควรเป็นสตริงชื่อย่อโดยไม่มีคำนำหน้ารหัสโปรเจ็กต์ เช่น หากต้องการดึงข้อมูล projects/project-id/rulesets/my-ruleset ให้ส่งชื่อย่อว่า "my-ruleset" ปฏิเสธโดยมีข้อผิดพลาด not-found หากไม่พบ Ruleset ที่ระบุ

ลายเซ็น:

getRuleset(name: string): Promise<Ruleset>;

พารามิเตอร์

การคืนสินค้า:

สัญญา<Ruleset>

คำมั่นสัญญาที่ทำตาม Ruleset ที่ระบุ

SecurityRule.getStorageRuleset()

รับชุดกฎที่ใช้กับที่เก็บข้อมูล Cloud Storage ในปัจจุบัน ปฏิเสธโดยมีข้อผิดพลาด not-found หากไม่มีการใช้ชุดกฎในที่เก็บข้อมูล

ลายเซ็น:

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

พารามิเตอร์

การคืนสินค้า:

สัญญา<Ruleset>

คำมั่นสัญญาที่บรรลุผลได้ด้วยชุดกฎ Cloud Storage

SecurityRule.listRulesetMetadata()

เรียกข้อมูลหน้าของข้อมูลเมตาของชุดกฎ

ลายเซ็น:

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

พารามิเตอร์

การคืนสินค้า:

Promise<RulesetMetadataList>

คำสัญญาที่เติมเต็มได้ด้วยหน้าชุดกฎ

SecurityRule.releaseFirestoreRuleset()

ปรับใช้ชุดกฎ Ruleset ที่ระบุกับ Cloud Firestore

ลายเซ็น:

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

พารามิเตอร์

การคืนสินค้า:

คำสัญญา<โมฆะ>

คำมั่นสัญญาที่จะเป็นไปตามเวลาที่ปล่อยชุดกฎ

SecurityRule.releaseFirestoreRulesetFromSource()

สร้าง Ruleset ใหม่จากแหล่งที่มาที่กำหนด และใช้กับ Cloud Firestore

ลายเซ็น:

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

พารามิเตอร์

การคืนสินค้า:

สัญญา<Ruleset>

คำมั่นสัญญาที่จะบรรลุผลเมื่อมีการสร้างและเปิดตัวชุดกฎ

SecurityRule.releaseStorageRuleset()

นำชุดกฎ Ruleset ที่ระบุไปใช้กับที่เก็บข้อมูล Cloud Storage

ลายเซ็น:

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

พารามิเตอร์

การคืนสินค้า:

คำสัญญา<โมฆะ>

คำมั่นสัญญาที่จะเป็นไปตามเวลาที่ปล่อยชุดกฎ

SecurityRule.releaseStorageRulesetFromSource()

สร้าง Ruleset ใหม่จากแหล่งที่มาที่กำหนด และใช้กับที่เก็บข้อมูล Cloud Storage

ลายเซ็น:

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

พารามิเตอร์

การคืนสินค้า:

สัญญา<Ruleset>

คำมั่นสัญญาที่จะบรรลุผลเมื่อมีการสร้างและเปิดตัวชุดกฎ