Interfejs usługi Firebase SecurityRules
.
Podpis:
export declare class SecurityRules
Nieruchomości
Nieruchomość | Modyfikatory | Typ | Opis |
---|---|---|---|
aplikacja | Aplikacja |
Metody
metoda | Modyfikatory | Opis |
---|---|---|
utwórz zestaw reguł (plik) | Tworzy nowy zestaw reguł na podstawie podanego pliku RulesFile . | |
createRulesFileFromSource(nazwa, źródło) | 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. | |
usuńzestaw reguł(nazwa) | 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 . | |
getFirestoreRuleset() | Pobiera zestaw reguł aktualnie zastosowany do Cloud Firestore. Odrzuca z błędem not-found , jeśli w Firestore nie zastosowano żadnego zestawu reguł. | |
getRuleset(nazwa) | 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 . | |
getStorageRuleset (wiadro) | Pobiera zestaw reguł aktualnie zastosowany do zasobnika Cloud Storage. Odrzuca z błędem not-found , jeśli do zasobnika nie zastosowano żadnego zestawu reguł. | |
listRulesetMetadata(rozmiar strony, token następnej strony) | Pobiera stronę metadanych zestawu reguł. | |
releaseFirestoreRuleset(zestaw reguł) | Stosuje określony zestaw reguł do Cloud Firestore. | |
releaseFirestoreRulesetFromSource(źródło) | Tworzy nowy zestaw reguł z danego źródła i stosuje go do Cloud Firestore. | |
releaseStorageRuleset(zestaw reguł, zasobnik) | Stosuje określony zestaw reguł zestawu reguł do zasobnika Cloud Storage. | |
releaseStorageRulesetFromSource(źródło, segment) | Tworzy nowy zestaw reguł z danego źródła i stosuje go do segmentu Cloud Storage. |
Aplikacja SecurityRules
Podpis:
readonly app: App;
SecurityRules.createRuleset()
Tworzy nowy zestaw reguł na podstawie podanego pliku RulesFile .
Podpis:
createRuleset(file: RulesFile): Promise<Ruleset>;
Parametry
Parametr | Typ | Opis |
---|---|---|
plik | Plik reguł | Plik reguł do dołączenia do nowego Ruleset . |
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
Parametr | Typ | Opis |
---|---|---|
nazwa | strunowy | Nazwa, która ma zostać przypisana do pliku reguł. Zwykle jest to krótka nazwa pliku, która pomaga zidentyfikować plik w zestawie reguł. |
źródło | ciąg | Bufor | Zawartość pliku reguł. |
Zwroty:
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
Parametr | Typ | Opis |
---|---|---|
nazwa | strunowy | Nazwa Ruleset do usunięcia. |
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
Parametr | Typ | Opis |
---|---|---|
nazwa | strunowy | Nazwa Ruleset do pobrania. |
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
Parametr | Typ | Opis |
---|---|---|
wiaderko | strunowy | Opcjonalna nazwa zasobnika Cloud Storage do pobrania. Jeśli nie określono, pobiera zestaw reguł zastosowany w domyślnym zasobniku skonfigurowanym za pomocą AppOptions . |
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
Parametr | Typ | Opis |
---|---|---|
rozmiar strony | numer | Rozmiar strony, 100, jeśli nieokreślony. Jest to również maksymalny dozwolony limit. |
token następnej strony | strunowy | Żeton następnej strony. Jeśli nie określono, zwraca zestawy reguł rozpoczynające się bez żadnego przesunięcia. |
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
Parametr | Typ | Opis |
---|---|---|
zestaw reguł | ciąg | Zestaw regułMetadane | Nazwa zestawu reguł do zastosowania lub obiektu RulesetMetadata zawierającego tę nazwę. |
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
Parametr | Typ | Opis |
---|---|---|
źródło | ciąg | Bufor | Źródło reguł do zastosowania. |
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
Parametr | Typ | Opis |
---|---|---|
zestaw reguł | ciąg | Zestaw regułMetadane | Nazwa zestawu reguł do zastosowania lub obiektu RulesetMetadata zawierającego tę nazwę. |
wiaderko | strunowy | Opcjonalna nazwa zasobnika Cloud Storage, dla którego mają zostać zastosowane reguły. Jeśli nie określono, stosuje zestaw reguł do domyślnego zasobnika skonfigurowanego za pomocą opcji AppOptions . |
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
Parametr | Typ | Opis |
---|---|---|
źródło | ciąg | Bufor | Źródło reguł do zastosowania. |
wiaderko | strunowy | Opcjonalna nazwa zasobnika Cloud Storage, dla którego mają zostać zastosowane reguły. Jeśli nie określono, stosuje zestaw reguł do domyślnego zasobnika skonfigurowanego za pomocą opcji AppOptions . |
Zwroty:
Obietnica< Zestaw zasad >
Obietnica, która spełnia się po utworzeniu i wydaniu zestawu reguł.