SecurityRules class

La interfaz del servicio Firebase SecurityRules .

Firma:

export declare class SecurityRules 

Propiedades

Métodos

SecurityRules.aplicación

Firma:

readonly app: App;

SecurityRules.createRuleset()

Crea un nuevo conjunto de reglas a partir del archivo de reglas proporcionado. .

Firma:

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

Parámetros

Devoluciones:

Promesa < conjunto de reglas >

Una promesa que se cumple con el recién creado Ruleset .

SecurityRules.createRulesFileFromSource()

Crea un RulesFile con el nombre y la fuente proporcionados. Lanza un error si alguno de los argumentos no es válido. Esta es una operación local y no implica ninguna llamada API de red.

Firma:

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

Parámetros

Devoluciones:

Archivo de reglas

Una nueva instancia de archivo de reglas.

Ejemplo

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

SecurityRules.deleteRuleset()

Elimina el conjunto de reglas identificado por el nombre de pila. El nombre de entrada debe ser la cadena de nombre corto sin el prefijo de ID del proyecto. Por ejemplo, para eliminar projects/project-id/rulesets/my-ruleset , pase el nombre corto "my-ruleset". Se rechaza con un error not-found si no se puede encontrar el Ruleset especificado.

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

Una promesa que se cumple cuando se elimina el Ruleset .

SecurityRules.getFirestoreRuleset()

Obtiene el conjunto de reglas aplicado actualmente a Cloud Firestore. Se rechaza con un error not-found si no se aplica ningún conjunto de reglas en Firestore.

Firma:

getFirestoreRuleset(): Promise<Ruleset>;

Devoluciones:

Promesa < conjunto de reglas >

Una promesa que cumple con el conjunto de reglas de Firestore.

SecurityRules.getRuleset()

Obtiene el conjunto de reglas identificado por el nombre de pila. El nombre de entrada debe ser la cadena de nombre corto sin el prefijo de ID del proyecto. Por ejemplo, para recuperar projects/project-id/rulesets/my-ruleset , pase el nombre corto "my-ruleset". Se rechaza con un error not-found si no se puede encontrar el Ruleset especificado.

Firma:

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

Parámetros

Devoluciones:

Promesa < conjunto de reglas >

Una promesa que cumple con el Ruleset especificado .

SecurityRules.getStorageRuleset()

Obtiene el conjunto de reglas aplicado actualmente a un depósito de Cloud Storage. Se rechaza con un error not-found si no se aplica ningún conjunto de reglas en el depósito.

Firma:

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

Parámetros

Devoluciones:

Promesa < conjunto de reglas >

Una promesa que cumple con el conjunto de reglas de Cloud Storage.

SecurityRules.listRulesetMetadata()

Recupera una página de metadatos del conjunto de reglas.

Firma:

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

Parámetros

Devoluciones:

Promesa< Conjunto de reglasLista de metadatos >

Una promesa que se cumple con una página de conjuntos de reglas.

SecurityRules.releaseFirestoreRuleset()

Aplica el conjunto de reglas del conjunto de reglas especificado a Cloud Firestore.

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

Una promesa que se cumple cuando se publica el conjunto de reglas.

SecurityRules.releaseFirestoreRulesetFromSource()

Crea un nuevo conjunto de reglas a partir de la fuente proporcionada y lo aplica a Cloud Firestore.

Firma:

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

Parámetros

Devoluciones:

Promesa < conjunto de reglas >

Una promesa que se cumple cuando se crea y publica el conjunto de reglas.

SecurityRules.releaseStorageRuleset()

Aplica el conjunto de reglas de conjunto de reglas especificado a un depósito de Cloud Storage.

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

Una promesa que se cumple cuando se publica el conjunto de reglas.

SecurityRules.releaseStorageRulesetFromSource()

Crea un nuevo conjunto de reglas a partir de la fuente dada y lo aplica a un depósito de Cloud Storage.

Firma:

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

Parámetros

Devoluciones:

Promesa < conjunto de reglas >

Una promesa que se cumple cuando se crea y publica el conjunto de reglas.