SecurityRules class

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

ลายเซ็น:

export declare class SecurityRules 

คุณสมบัติ

วิธีการ

SecurityRules.app

ลายเซ็น:

readonly app: App;

SecurityRules.createRuleset()

สร้าง Ruleset ใหม่จาก 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 ให้ส่งชื่อย่อว่า "my-ruleset" ปฏิเสธโดยมีข้อผิดพลาด not-found หากไม่พบ Ruleset ที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

ผลตอบแทน:

สัญญา<โมฆะ>

คำสัญญาที่จะเกิดขึ้นเมื่อมีการลบ Ruleset

SecurityRules.getFirestoreRuleset()

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

ลายเซ็น:

getFirestoreRuleset(): Promise<Ruleset>;

ผลตอบแทน:

สัญญา < ชุดกฎ >

คำสัญญาที่เป็นไปตามชุดกฎของ Firestore

SecurityRules.getRuleset()

รับ ชุดกฎ ที่ระบุโดยชื่อที่กำหนด ชื่ออินพุตควรเป็นสตริงชื่อแบบสั้นโดยไม่มีคำนำหน้ารหัสโปรเจ็กต์ ตัวอย่างเช่น เพื่อดึงข้อมูล projects/project-id/rulesets/my-ruleset ให้ส่งชื่อย่อว่า "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>;

พารามิเตอร์

ผลตอบแทน:

สัญญา<โมฆะ>

คำสัญญาที่จะเกิดขึ้นเมื่อมีการเผยแพร่กฎเกณฑ์

SecurityRules.releaseFirestoreRulesetFromSource()

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

ลายเซ็น:

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

พารามิเตอร์

ผลตอบแทน:

สัญญา < ชุดกฎ >

คำสัญญาที่จะเกิดขึ้นเมื่อมีการสร้างและเผยแพร่ชุดกฎ

SecurityRules.releaseStorageRuleset()

ใช้ชุดกฎ ของกฎ ที่ระบุกับที่เก็บข้อมูล Cloud Storage

ลายเซ็น:

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

พารามิเตอร์

ผลตอบแทน:

สัญญา<โมฆะ>

คำสัญญาที่จะเกิดขึ้นเมื่อมีการเผยแพร่กฎเกณฑ์

SecurityRules.releaseStorageRulesetFromSource()

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

ลายเซ็น:

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

พารามิเตอร์

ผลตอบแทน:

สัญญา < ชุดกฎ >

คำสัญญาที่จะเกิดขึ้นเมื่อมีการสร้างและเผยแพร่ชุดกฎ