फायरबेस SecurityRules
सेवा इंटरफ़ेस।
हस्ताक्षर:
export declare class SecurityRules
गुण
संपत्ति | संशोधक | प्रकार | विवरण |
---|---|---|---|
अनुप्रयोग | अनुप्रयोग |
तरीकों
तरीका | संशोधक | विवरण |
---|---|---|
createRuleset(फ़ाइल) | दिए गए रूल्सफ़ाइल से एक नया रूल्ससेट बनाता है . | |
createRulesFileFromSource(नाम, स्रोत) | दिए गए नाम और स्रोत के साथ एक रूल्सफ़ाइल बनाता है। यदि कोई भी तर्क अमान्य है तो एक त्रुटि उत्पन्न होती है। यह एक स्थानीय ऑपरेशन है, और इसमें कोई नेटवर्क एपीआई कॉल शामिल नहीं है। | |
डिलीटरूलसेट(नाम) | दिए गए नाम से पहचाने गए नियम-सेट को हटा देता है। इनपुट नाम प्रोजेक्ट आईडी उपसर्ग के बिना संक्षिप्त नाम स्ट्रिंग होना चाहिए। उदाहरण के लिए, projects/project-id/rulesets/my-ruleset हटाने के लिए, संक्षिप्त नाम "my-ruleset" पास करें। यदि निर्दिष्ट Ruleset नहीं मिल पाता है तो not-found फ़ाउंड' त्रुटि के साथ अस्वीकार कर दिया जाता है। | |
getFirestoreRuleset() | वर्तमान में क्लाउड फायरस्टोर पर लागू नियम सेट प्राप्त करता है। यदि फ़ायरस्टोर पर कोई नियम-सेट लागू नहीं किया गया है तो not-found त्रुटि के साथ अस्वीकार कर दिया जाता है। | |
getRuleset(नाम) | दिए गए नाम से नियम-सेट की पहचान करवाता है। इनपुट नाम प्रोजेक्ट आईडी उपसर्ग के बिना संक्षिप्त नाम स्ट्रिंग होना चाहिए। उदाहरण के लिए, projects/project-id/rulesets/my-ruleset पुनः प्राप्त करने के लिए, संक्षिप्त नाम "माय-रूलसेट" पास करें। यदि निर्दिष्ट Ruleset नहीं मिल पाता है तो not-found फ़ाउंड' त्रुटि के साथ अस्वीकार कर दिया जाता है। | |
getStorageRuleset(बाल्टी) | वर्तमान में क्लाउड स्टोरेज बकेट पर लागू नियम सेट प्राप्त करता है। यदि बकेट पर कोई नियम-सेट लागू नहीं किया गया है तो not-found त्रुटि के साथ अस्वीकार कर दिया जाता है। | |
listRulesetMetadata(पेज आकार, अगला पेजटोकन) | नियम-सेट मेटाडेटा का एक पृष्ठ पुनर्प्राप्त करता है। | |
रिलीजफायरस्टोररूलसेट(नियमसेट) | निर्दिष्ट नियम -सेट को क्लाउड फायरस्टोर पर लागू करता है। | |
रिलीजफायरस्टोररूल्सेटफ्रॉमसोर्स(स्रोत) | दिए गए स्रोत से एक नया नियम सेट बनाता है, और इसे क्लाउड फायरस्टोर पर लागू करता है। | |
रिलीजस्टोरेजरूलसेट(नियमसेट, बकेट) | निर्दिष्ट नियम- सेट को क्लाउड स्टोरेज बकेट पर लागू करता है। | |
रिलीजस्टोरेजरूलसेटफ्रॉमसोर्स(स्रोत, बकेट) | दिए गए स्रोत से एक नया नियम सेट बनाता है, और इसे क्लाउड स्टोरेज बकेट पर लागू करता है। |
SecurityRules.app
हस्ताक्षर:
readonly app: App;
SecurityRules.createRuleset()
दिए गए रूल्सफ़ाइल से एक नया रूल्ससेट बनाता है .
हस्ताक्षर:
createRuleset(file: RulesFile): Promise<Ruleset>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
फ़ाइल | नियमफ़ाइल | नए 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 का नाम. |
रिटर्न:
वादा<शून्य>
एक वादा जो 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 का नाम. |
रिटर्न:
वादा< नियम-सेट >
एक वादा जो निर्दिष्ट Ruleset
के साथ पूरा होता है .
SecurityRules.getStorageRuleset()
वर्तमान में क्लाउड स्टोरेज बकेट पर लागू नियम सेट प्राप्त करता है। यदि बकेट पर कोई नियम-सेट लागू नहीं किया गया है तो not-found
त्रुटि के साथ अस्वीकार कर दिया जाता है।
हस्ताक्षर:
getStorageRuleset(bucket?: string): Promise<Ruleset>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
बाल्टी | डोरी | पुनर्प्राप्त किए जाने वाले क्लाउड स्टोरेज बकेट का वैकल्पिक नाम। यदि निर्दिष्ट नहीं है, तो AppOptions के माध्यम से कॉन्फ़िगर किए गए डिफ़ॉल्ट बकेट पर लागू नियम को पुनः प्राप्त करता है। |
रिटर्न:
वादा< नियम-सेट >
एक वादा जो क्लाउड स्टोरेज नियम के साथ पूरा होता है।
SecurityRules.listRulesetMetadata()
नियम-सेट मेटाडेटा का एक पृष्ठ पुनर्प्राप्त करता है।
हस्ताक्षर:
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
पृष्ठ आकार | संख्या | पृष्ठ का आकार, 100 यदि अपरिभाषित है। यह अधिकतम अनुमत सीमा भी है. |
अगलापेजटोकन | डोरी | अगले पेज का टोकन. यदि निर्दिष्ट नहीं है, तो बिना किसी ऑफसेट के शुरू होने वाले नियमसेट लौटाता है। |
रिटर्न:
वादा < नियमसेटमेटाडेटा सूची >
एक वादा जो नियमों के एक पन्ने के साथ पूरा होता है।
SecurityRules.releaseFirestoreRuleset()
निर्दिष्ट नियम -सेट को क्लाउड फायरस्टोर पर लागू करता है।
हस्ताक्षर:
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
नियम-सेट | स्ट्रिंग | नियमसेटमेटाडेटा | लागू करने के लिए नियम सेट का नाम या नाम युक्त एक RulesetMetadata ऑब्जेक्ट। |
रिटर्न:
वादा<शून्य>
एक वादा जो नियमावली जारी होने पर पूरा होता है।
SecurityRules.releaseFirestoreRulesetFromSource()
दिए गए स्रोत से एक नया नियम सेट बनाता है, और इसे क्लाउड फायरस्टोर पर लागू करता है।
हस्ताक्षर:
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
स्रोत | स्ट्रिंग | बफर | लागू करने हेतु नियम स्रोत. |
रिटर्न:
वादा< नियम-सेट >
एक वादा जो नियमों के बनने और जारी होने पर पूरा होता है।
SecurityRules.releaseStorageRuleset()
निर्दिष्ट नियम- सेट को क्लाउड स्टोरेज बकेट पर लागू करता है।
हस्ताक्षर:
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
नियम-सेट | स्ट्रिंग | नियमसेटमेटाडेटा | लागू करने के लिए नियम सेट का नाम या नाम युक्त एक RulesetMetadata ऑब्जेक्ट। |
बाल्टी | डोरी | नियमों को लागू करने के लिए क्लाउड स्टोरेज बकेट का वैकल्पिक नाम। यदि निर्दिष्ट नहीं है, तो AppOptions के माध्यम से कॉन्फ़िगर किए गए डिफ़ॉल्ट बकेट पर नियम लागू करता है . |
रिटर्न:
वादा<शून्य>
एक वादा जो नियमावली जारी होने पर पूरा होता है।
SecurityRules.releaseStorageRulesetFromSource()
दिए गए स्रोत से एक नया नियम सेट बनाता है, और इसे क्लाउड स्टोरेज बकेट पर लागू करता है।
हस्ताक्षर:
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
स्रोत | स्ट्रिंग | बफर | लागू करने हेतु नियम स्रोत. |
बाल्टी | डोरी | नियमों को लागू करने के लिए क्लाउड स्टोरेज बकेट का वैकल्पिक नाम। यदि निर्दिष्ट नहीं है, तो AppOptions के माध्यम से कॉन्फ़िगर किए गए डिफ़ॉल्ट बकेट पर नियम लागू करता है . |
रिटर्न:
वादा< नियम-सेट >
एक वादा जो नियमों के बनने और जारी होने पर पूरा होता है।