SecurityRules class

फायरबेस SecurityRules सेवा इंटरफ़ेस।

हस्ताक्षर:

export declare class SecurityRules 

गुण

तरीकों

SecurityRules.app

हस्ताक्षर:

readonly app: App;

SecurityRules.createRuleset()

दिए गए रूल्सफ़ाइल से एक नया रूल्ससेट बनाता है .

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< नियम-सेट >

एक वादा जो नव निर्मित Ruleset के साथ पूरा होता है .

SecurityRules.createRulesFileFromSource()

दिए गए नाम और स्रोत के साथ एक रूल्सफ़ाइल बनाता है। यदि कोई भी तर्क अमान्य है तो एक त्रुटि उत्पन्न होती है। यह एक स्थानीय ऑपरेशन है, और इसमें कोई नेटवर्क एपीआई कॉल शामिल नहीं है।

हस्ताक्षर:

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 हटाने के लिए , संक्षिप्त नाम "my-ruleset" पास करें। यदि निर्दिष्ट Ruleset नहीं मिल पाता है तो not-found फ़ाउंड' त्रुटि के साथ अस्वीकार कर दिया जाता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<शून्य>

एक वादा जो Ruleset हटाए जाने पर पूरा होता है।

SecurityRules.getFirestoreRuleset()

वर्तमान में क्लाउड फायरस्टोर पर लागू नियम सेट प्राप्त करता है। यदि फ़ायरस्टोर पर कोई नियम-सेट लागू नहीं किया गया है तो not-found त्रुटि के साथ अस्वीकार कर दिया जाता है।

हस्ताक्षर:

getFirestoreRuleset(): Promise<Ruleset>;

रिटर्न:

वादा< नियम-सेट >

एक वादा जो फायरस्टोर नियम-सेट के साथ पूरा होता है।

SecurityRules.getRuleset()

दिए गए नाम से नियम-सेट की पहचान करवाता है। इनपुट नाम प्रोजेक्ट आईडी उपसर्ग के बिना संक्षिप्त नाम स्ट्रिंग होना चाहिए। उदाहरण के लिए, projects/project-id/rulesets/my-ruleset पुनः प्राप्त करने के लिए , संक्षिप्त नाम "my-ruleset" पास करें। यदि निर्दिष्ट Ruleset नहीं मिल पाता है तो not-found फ़ाउंड' त्रुटि के साथ अस्वीकार कर दिया जाता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< नियम-सेट >

एक वादा जो निर्दिष्ट Ruleset के साथ पूरा होता है .

SecurityRules.getStorageRuleset()

वर्तमान में क्लाउड स्टोरेज बकेट पर लागू नियम सेट प्राप्त करता है। यदि बकेट पर कोई नियम-सेट लागू नहीं किया गया है तो not-found त्रुटि के साथ अस्वीकार कर दिया जाता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< नियम-सेट >

एक वादा जो क्लाउड स्टोरेज नियम के साथ पूरा होता है।

SecurityRules.listRulesetMetadata()

नियम-सेट मेटाडेटा का एक पृष्ठ पुनर्प्राप्त करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा < नियमसेटमेटाडेटा सूची >

एक वादा जो नियमों के एक पन्ने के साथ पूरा होता है।

SecurityRules.releaseFirestoreRuleset()

निर्दिष्ट नियम -सेट को क्लाउड फायरस्टोर पर लागू करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<शून्य>

एक वादा जो नियमावली जारी होने पर पूरा होता है।

SecurityRules.releaseFirestoreRulesetFromSource()

दिए गए स्रोत से एक नया नियम सेट बनाता है, और इसे क्लाउड फायरस्टोर पर लागू करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< नियम-सेट >

एक वादा जो नियमों के बनने और जारी होने पर पूरा होता है।

SecurityRules.releaseStorageRuleset()

निर्दिष्ट नियम- सेट को क्लाउड स्टोरेज बकेट पर लागू करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा<शून्य>

एक वादा जो नियमावली जारी होने पर पूरा होता है।

SecurityRules.releaseStorageRulesetFromSource()

दिए गए स्रोत से एक नया नियम सेट बनाता है, और इसे क्लाउड स्टोरेज बकेट पर लागू करता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< नियम-सेट >

एक वादा जो नियमों के बनने और जारी होने पर पूरा होता है।