SecurityRules class

L'interfaccia del servizio Firebase SecurityRules .

Firma:

export declare class SecurityRules 

Proprietà

Metodi

SecurityRules.app

Firma:

readonly app: App;

SecurityRules.createRuleset()

Crea un nuovo set di regole dal RulesFile specificato .

Firma:

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

Parametri

Ritorna:

Promessa< Regole >

Una promessa che si mantiene con il Ruleset appena creato .

SecurityRules.createRulesFileFromSource()

Crea un RulesFile con il nome e l'origine specificati. Genera un errore se uno qualsiasi degli argomenti non è valido. Si tratta di un'operazione locale e non implica alcuna chiamata API di rete.

Firma:

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

Parametri

Ritorna:

RulesFile

Una nuova istanza del file di regole.

Esempio

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

SecurityRules.deleteRuleset()

Elimina il set di regole identificato dal nome dato. Il nome di input deve essere la stringa del nome breve senza il prefisso dell'ID progetto. Ad esempio, per eliminare projects/project-id/rulesets/my-ruleset , passa il nome breve "my-ruleset". Rifiuta con un errore not-found se non è possibile trovare il Ruleset specificato.

Firma:

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

Parametri

Ritorna:

Promesso<vuoto>

Una promessa che viene mantenuta quando il Ruleset viene eliminato.

SecurityRules.getFirestoreRuleset()

Ottiene il set di regole attualmente applicato a Cloud Firestore. Rifiuta con un errore not-found se su Firestore non viene applicato alcun set di regole.

Firma:

getFirestoreRuleset(): Promise<Ruleset>;

Ritorna:

Promessa< Regole >

Una promessa che viene mantenuta con il set di regole Firestore.

SecurityRules.getRuleset()

Ottiene il set di regole identificato dal nome specificato. Il nome di input deve essere la stringa del nome breve senza il prefisso dell'ID progetto. Ad esempio, per recuperare projects/project-id/rulesets/my-ruleset , passa il nome breve "my-ruleset". Rifiuta con un errore not-found se non è possibile trovare il Ruleset specificato.

Firma:

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

Parametri

Ritorna:

Promessa< Regole >

Una promessa che soddisfa il Ruleset specificato .

SecurityRules.getStorageRuleset()

Ottiene il set di regole attualmente applicato a un bucket Cloud Storage. Rifiuta con un errore not-found se al bucket non viene applicato alcun set di regole.

Firma:

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

Parametri

Ritorna:

Promessa< Regole >

Una promessa che viene mantenuta con il set di regole di Cloud Storage.

SecurityRules.listRulesetMetadata()

Recupera una pagina di metadati del set di regole.

Firma:

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

Parametri

Ritorna:

Promessa< RulesetMetadataList >

Una promessa che si mantiene con una pagina di regole.

SecurityRules.releaseFirestoreRuleset()

Applica il set di regole del set di regole specificato a Cloud Firestore.

Firma:

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

Parametri

Ritorna:

Promesso<vuoto>

Una promessa che si mantiene quando le regole vengono rilasciate.

SecurityRules.releaseFirestoreRulesetFromSource()

Crea un nuovo set di regole dall'origine specificata e lo applica a Cloud Firestore.

Firma:

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

Parametri

Ritorna:

Promessa< Regole >

Una promessa che si mantiene quando le regole vengono create e rilasciate.

SecurityRules.releaseStorageRuleset()

Applica il set di regole del set di regole specificato a un bucket Cloud Storage.

Firma:

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

Parametri

Ritorna:

Promesso<vuoto>

Una promessa che si mantiene quando le regole vengono rilasciate.

SecurityRules.releaseStorageRulesetFromSource()

Crea un nuovo set di regole dall'origine specificata e lo applica a un bucket Cloud Storage.

Firma:

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

Parametri

Ritorna:

Promessa< Regole >

Una promessa che si mantiene quando le regole vengono create e rilasciate.