SecurityRules class

La interfaz del servicio Firebase SecurityRules .

Firma:

export declare class SecurityRules 

Propiedades

Métodos

Reglas de seguridad.app

Firma:

readonly app: App;

Reglas de seguridad.createRuleset()

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

Firma:

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

Parámetros

Devoluciones:

Promesa< conjunto de reglas >

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

SecurityRules.createRulesFileFromSource()

Crea un archivo de reglas con el nombre y la fuente especificados. 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 dado. El nombre de entrada debe ser la cadena de nombre abreviado sin el prefijo de ID del proyecto. Por ejemplo, para eliminar los projects/project-id/rulesets/my-ruleset , pase el nombre abreviado "my-ruleset". Se rechaza con un error not-found si no se puede encontrar el conjunto de Ruleset especificado.

Firma:

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

Parámetros

Devoluciones:

Promesa <vacío>

Una promesa que se cumple cuando se elimina el conjunto de Ruleset .

Reglas de seguridad.getFirestoreRuleset()

Obtiene el conjunto de reglas aplicado actualmente a Cloud Firestore. 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.

Reglas de seguridad.getRuleset()

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

Firma:

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

Parámetros

Devoluciones:

Promesa< conjunto de reglas >

Una promesa que cumple con el Ruleset especificado .

Reglas de seguridad.getStorageRuleset()

Obtiene el conjunto de reglas que se aplica 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:

Promise< conjunto de reglasMetadataList >

Una promesa que cumple con una página 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 <vacío>

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 dada 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 se publica el conjunto de reglas.

SecurityRules.releaseStorageRuleset()

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

Firma:

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

Parámetros

Devoluciones:

Promesa <vacío>

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 se publica el conjunto de reglas.