SecurityRules class

La interfaz del servicio SecurityRules de Firebase

Firma:

export declare class SecurityRules 

Propiedades

Métodos

ReglasDeSeguridad.app

Firma:

readonly app: App;

SecurityRules.createRuleset()

Crea un Ruleset nuevo a partir del RulesFile especificado.

Firma:

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

Parámetros

Muestra:

Promesa<Conjunto de reglas>

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

SecurityRules.createRulesFileFromSource()

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

Firma:

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

Parámetros

Muestra:

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()

Borra el Conjunto de reglas que se identifica con el nombre dado. El nombre de entrada debe ser la cadena de nombre corto sin el prefijo de ID del proyecto. Por ejemplo, para borrar el projects/project-id/rulesets/my-ruleset, pasa 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

Muestra:

Promesa<void>

Una promesa que se cumple cuando se borra Ruleset.

SecurityRules.getFirestoreRuleset()

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

Muestra:

Promesa<Conjunto de reglas>

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

SecurityRules.getRuleset()

Obtiene el conjunto de reglas identificado mediante el nombre dado. El nombre de entrada debe ser la cadena de nombre corto sin el prefijo de ID del proyecto. Por ejemplo, para recuperar el projects/project-id/rulesets/my-ruleset, pasa 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

Muestra:

Promesa<Conjunto de reglas>

Una promesa que se cumple con el Ruleset especificado.

SecurityRules.getStorageRuleset()

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

Firma:

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

Parámetros

Muestra:

Promesa<Conjunto de reglas>

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

SecurityRules.listRulesetMetadata()

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

Firma:

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

Parámetros

Muestra:

Promesa<RulesetMetadataList>

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

Muestra:

Promesa<void>

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

SecurityRules.releaseFirestoreRulesetFromSource()

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

Firma:

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

Parámetros

Muestra:

Promesa<Conjunto de reglas>

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

SecurityRules.releaseStorageRuleset()

Aplica el conjunto de reglas del conjunto de reglas especificado a un bucket de Cloud Storage.

Firma:

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

Parámetros

Muestra:

Promesa<void>

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

SecurityRules.releaseStorageRulesetFromSource()

Crea un conjunto de reglas nuevo a partir de la fuente determinada y lo aplica a un bucket de Cloud Storage.

Firma:

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

Parámetros

Muestra:

Promesa<Conjunto de reglas>

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