SecurityRules class

Interfejs usługi Firebase SecurityRules .

Podpis:

export declare class SecurityRules 

Nieruchomości

Metody

Aplikacja SecurityRules

Podpis:

readonly app: App;

SecurityRules.createRuleset()

Tworzy nowy zestaw reguł na podstawie podanego pliku RulesFile .

Podpis:

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

Parametry

Zwroty:

Obietnica< Zestaw zasad >

Obietnica, która spełnia się dzięki nowo utworzonemu Ruleset .

SecurityRules.createRulesFileFromSource()

Tworzy plik RulesFile o podanej nazwie i źródle. Zgłasza błąd, jeśli którykolwiek z argumentów jest nieprawidłowy. Jest to operacja lokalna i nie obejmuje żadnych wywołań API sieci.

Podpis:

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

Parametry

Zwroty:

Plik reguł

Nowa instancja pliku reguł.

Przykład

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

SecurityRules.deleteRuleset()

Usuwa zestaw reguł identyfikowany przez podaną nazwę. Nazwa wejściowa powinna być ciągiem krótkiej nazwy bez przedrostka identyfikatora projektu. Na przykład, aby usunąć projects/project-id/rulesets/my-ruleset , podaj krótką nazwę „my-ruleset”. Odrzuca z błędem not-found , jeśli nie można znaleźć określonego Ruleset .

Podpis:

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

Parametry

Zwroty:

Obietnica<pusta>

Obietnica, która spełnia się, gdy Ruleset zostanie usunięty.

SecurityRules.getFirestoreRuleset()

Pobiera zestaw reguł aktualnie zastosowany do Cloud Firestore. Odrzuca z błędem not-found , jeśli w Firestore nie zastosowano żadnego zestawu reguł.

Podpis:

getFirestoreRuleset(): Promise<Ruleset>;

Zwroty:

Obietnica< Zestaw zasad >

Obietnica, która spełnia zestaw reguł Firestore.

SecurityRules.getRuleset()

Pobiera zestaw reguł identyfikowany przez podaną nazwę. Nazwa wejściowa powinna być ciągiem krótkiej nazwy bez przedrostka identyfikatora projektu. Na przykład, aby pobrać projects/project-id/rulesets/my-ruleset , podaj krótką nazwę „my-ruleset”. Odrzuca z błędem not-found , jeśli nie można znaleźć określonego Ruleset .

Podpis:

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

Parametry

Zwroty:

Obietnica< Zestaw zasad >

Obietnica, która spełnia określony Ruleset .

SecurityRules.getStorageRuleset()

Pobiera zestaw reguł aktualnie zastosowany do zasobnika Cloud Storage. Odrzuca z błędem not-found , jeśli do zasobnika nie zastosowano żadnego zestawu reguł.

Podpis:

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

Parametry

Zwroty:

Obietnica< Zestaw zasad >

Obietnica, która spełnia zestaw reguł Cloud Storage.

SecurityRules.listRulesetMetadata()

Pobiera stronę metadanych zestawu reguł.

Podpis:

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

Parametry

Zwroty:

Obietnica< Zestaw regułMetadataList >

Obietnica, która spełnia się wraz ze stroną z zestawami reguł.

SecurityRules.releaseFirestoreRuleset()

Stosuje określony zestaw reguł do Cloud Firestore.

Podpis:

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

Parametry

Zwroty:

Obietnica<pusta>

Obietnica, która spełnia się po wydaniu zestawu reguł.

SecurityRules.releaseFirestoreRulesetFromSource()

Tworzy nowy zestaw reguł z danego źródła i stosuje go do Cloud Firestore.

Podpis:

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

Parametry

Zwroty:

Obietnica< Zestaw zasad >

Obietnica, która spełnia się po utworzeniu i wydaniu zestawu reguł.

SecurityRules.releaseStorageRuleset()

Stosuje określony zestaw reguł zestawu reguł do zasobnika Cloud Storage.

Podpis:

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

Parametry

Zwroty:

Obietnica<pusta>

Obietnica, która spełnia się po wydaniu zestawu reguł.

SecurityRules.releaseStorageRulesetFromSource()

Tworzy nowy zestaw reguł z danego źródła i stosuje go do segmentu Cloud Storage.

Podpis:

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

Parametry

Zwroty:

Obietnica< Zestaw zasad >

Obietnica, która spełnia się po utworzeniu i wydaniu zestawu reguł.