SecurityRules class

La interfaz del servicio Firebase SecurityRules .

Firma:

export declare class SecurityRules

Propiedades

Propiedad Modificadores Tipo Descripción
aplicación Aplicación

Métodos

Método Modificadores Descripción
crear conjunto de reglas (archivo) Crea un nuevo conjunto de reglas a partir del archivo de reglas proporcionado. .
crearRulesFileFromSource(nombre, fuente) 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.
eliminarConjunto de reglas(nombre) 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.
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.
getRuleset(nombre) 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 "mi-conjunto de reglas". Se rechaza con un error not-found si no se puede encontrar el Ruleset especificado.
getStorageRuleset(depósito) 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.
listRulesetMetadata(tamaño de página, nextPageToken) Recupera una página de metadatos del conjunto de reglas.
lanzamientoFirestoreRuleset(conjunto de reglas) Aplica el conjunto de reglas del conjunto de reglas especificado a Cloud Firestore.
lanzamientoFirestoreRulesetFromSource(fuente) Crea un nuevo conjunto de reglas a partir de la fuente proporcionada y lo aplica a Cloud Firestore.
releaseStorageRuleset(conjunto de reglas, depósito) Aplica el conjunto de reglas de conjunto de reglas especificado a un depósito de Cloud Storage.
releaseStorageRulesetFromSource(fuente, depósito) Crea un nuevo conjunto de reglas a partir de la fuente dada y lo aplica a un depósito de Cloud Storage.

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

Parámetro Tipo Descripción
archivo Archivo de reglas Archivo de reglas para incluir en el nuevo Ruleset .

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

Parámetro Tipo Descripción
nombre cadena Nombre para asignar al archivo de reglas. Suele ser un nombre de archivo corto que ayuda a identificar el archivo en un conjunto de reglas.
fuente cadena | Buffer Contenido del archivo de reglas.

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

Parámetro Tipo Descripción
nombre cadena Nombre del Ruleset a eliminar.

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

Parámetro Tipo Descripción
nombre cadena Nombre del Ruleset a recuperar.

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

Parámetro Tipo Descripción
balde cadena Nombre opcional del depósito de Cloud Storage que se recuperará. Si no se especifica, recupera el conjunto de reglas aplicado en el depósito predeterminado configurado a través de AppOptions .

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

Parámetro Tipo Descripción
tamaño de página número El tamaño de la página, 100 si no está definido. Este es también el límite máximo permitido.
token de página siguiente cadena El token de la página siguiente. Si no se especifica, devuelve conjuntos de reglas que comienzan sin ningún desplazamiento.

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

Parámetro Tipo Descripción
conjunto de reglas cadena | Conjunto de reglasMetadatos Nombre del conjunto de reglas a aplicar o un objeto RulesetMetadata que contiene el nombre.

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

Parámetro Tipo Descripción
fuente cadena | Buffer Fuente de reglas a aplicar.

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

Parámetro Tipo Descripción
conjunto de reglas cadena | Conjunto de reglasMetadatos Nombre del conjunto de reglas a aplicar o un objeto RulesetMetadata que contiene el nombre.
balde cadena Nombre opcional del depósito de Cloud Storage al que aplicar las reglas. Si no se especifica, aplica el conjunto de reglas en el depósito predeterminado configurado a través de AppOptions .

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

Parámetro Tipo Descripción
fuente cadena | Buffer Fuente de reglas a aplicar.
balde cadena Nombre opcional del depósito de Cloud Storage al que aplicar las reglas. Si no se especifica, aplica el conjunto de reglas en el depósito predeterminado configurado a través de AppOptions .

Devoluciones:

Promesa < conjunto de reglas >

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