SecurityRules class

Die Firebase SecurityRules Dienstschnittstelle.

Unterschrift:

export declare class SecurityRules 

Eigenschaften

Methoden

SecurityRules.app

Unterschrift:

readonly app: App;

SecurityRules.createRuleset()

Erstellt einen neuen Regelsatz aus der angegebenen RulesFile .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< Regelsatz >

Ein Versprechen, das mit dem neu erstellten Ruleset eingelöst wird .

SecurityRules.createRulesFileFromSource()

Erstellt eine Regeldatei mit dem angegebenen Namen und der angegebenen Quelle. Gibt einen Fehler aus, wenn eines der Argumente ungültig ist. Dies ist ein lokaler Vorgang und erfordert keine Netzwerk-API-Aufrufe.

Unterschrift:

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

Parameter

Kehrt zurück:

Regeldatei

Eine neue Regeldateiinstanz.

Beispiel

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

SecurityRules.deleteRuleset()

Löscht den durch den angegebenen Namen identifizierten Regelsatz . Der Eingabename sollte die Kurznamenzeichenfolge ohne das Projekt-ID-Präfix sein. Zum Beispiel, um projects/project-id/rulesets/my-ruleset zu löschen , übergeben Sie den Kurznamen „my-ruleset“. Lehnt mit der Fehlermeldung not-found ab, wenn der angegebene Ruleset nicht gefunden werden kann.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<void>

Ein Versprechen, das erfüllt wird, wenn der Ruleset gelöscht wird.

SecurityRules.getFirestoreRuleset()

Ruft den aktuell auf Cloud Firestore angewendeten Regelsatz ab. Wird mit der Fehlermeldung not-found abgelehnt, wenn kein Regelsatz auf Firestore angewendet wird.

Unterschrift:

getFirestoreRuleset(): Promise<Ruleset>;

Kehrt zurück:

Versprechen< Regelsatz >

Ein Versprechen, das mit dem Firestore-Regelsatz erfüllt wird.

SecurityRules.getRuleset()

Ruft den durch den angegebenen Namen identifizierten Regelsatz ab. Der Eingabename sollte die Kurznamenzeichenfolge ohne das Projekt-ID-Präfix sein. Zum Beispiel, um projects/project-id/rulesets/my-ruleset abzurufen , übergeben Sie den Kurznamen „my-ruleset“. Lehnt mit der Fehlermeldung not-found ab, wenn der angegebene Ruleset nicht gefunden werden kann.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< Regelsatz >

Ein Versprechen, das den angegebenen Ruleset erfüllt .

SecurityRules.getStorageRuleset()

Ruft den Regelsatz ab, der derzeit auf einen Cloud Storage-Bucket angewendet wird. Lehnt mit der Fehlermeldung not-found ab, wenn kein Regelsatz auf den Bucket angewendet wird.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< Regelsatz >

Ein Versprechen, das mit dem Cloud Storage-Regelwerk erfüllt wird.

SecurityRules.listRulesetMetadata()

Ruft eine Seite mit Regelsatzmetadaten ab.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< RulesetMetadataList >

Ein Versprechen, das mit einer Seite voller Regelsätze erfüllt wird.

SecurityRules.releaseFirestoreRuleset()

Wendet den angegebenen Regelsatz- Regelsatz auf Cloud Firestore an.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<void>

Ein Versprechen, das erfüllt wird, wenn der Regelsatz veröffentlicht wird.

SecurityRules.releaseFirestoreRulesetFromSource()

Erstellt einen neuen Regelsatz aus der angegebenen Quelle und wendet ihn auf Cloud Firestore an.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< Regelsatz >

Ein Versprechen, das erfüllt wird, wenn der Regelsatz erstellt und veröffentlicht wird.

SecurityRules.releaseStorageRuleset()

Wendet den angegebenen Regelsatz- Regelsatz auf einen Cloud Storage-Bucket an.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<void>

Ein Versprechen, das erfüllt wird, wenn der Regelsatz veröffentlicht wird.

SecurityRules.releaseStorageRulesetFromSource()

Erstellt einen neuen Regelsatz aus der angegebenen Quelle und wendet ihn auf einen Cloud Storage-Bucket an.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< Regelsatz >

Ein Versprechen, das erfüllt wird, wenn der Regelsatz erstellt und veröffentlicht wird.