SecurityRules class

A interface de serviço SecurityRules do Firebase.

Assinatura:

export declare class SecurityRules 

Propriedades

Propriedade	Modificadores	Tipo	Descrição
app		App

Métodos

Método	Modificadores	Descrição
createRuleset(file) (em inglês)		Cria um novo Ruleset do RulesFile especificado.
createRulesFileFromSource(nome, origem)		Cria um RulesFile com o nome e a origem fornecidos. Um erro será exibido se algum dos argumentos for inválido. Essa é uma operação local e não envolve chamadas de API de rede.
deleteRuleset(name).		Exclui o Conjunto de regras identificado pelo nome fornecido. O nome da entrada precisa ser a string de nome curta sem o prefixo do ID do projeto. Por exemplo, para excluir projects/project-id/rulesets/my-ruleset, transmita o nome curto "my-ruleset". Rejeita com um erro not-found se o Ruleset especificado não puder ser encontrado.
getFirestoreRuleset()		Recebe o Conjunto de regras atualmente aplicado ao Cloud Firestore. Rejeita com um erro not-found se nenhum conjunto de regras for aplicado no Firestore.
getRuleset(name) (link em inglês)		Recebe o Ruleset identificado pelo nome fornecido. O nome da entrada precisa ser a string de nome curta sem o prefixo do ID do projeto. Por exemplo, para recuperar o projects/project-id/rulesets/my-ruleset, transmita o nome curto "my-ruleset". Rejeita com um erro not-found se o Ruleset especificado não puder ser encontrado.
getStorageRuleset(bucket)		Recebe o Conjunto de regras atualmente aplicado a um bucket do Cloud Storage. Rejeita com um erro not-found se nenhum conjunto de regras for aplicado no bucket.
listRulesetMetadata(pageSize, nextPageToken)		Recupera uma página de metadados do conjunto de regras.
releaseFirestoreRuleset(ruleset)		Aplica o conjunto de regras Ruleset especificado ao Cloud Firestore.
releaseFirestoreRulesetFromSource(origem)		Cria um novo Ruleset da origem especificada e o aplica ao Cloud Firestore.
releaseStorageRuleset(conjunto de regras, bucket)		Aplica o conjunto de regras Ruleset especificado a um bucket do Cloud Storage.
releaseStorageRulesetFromSource(origem, bucket)		Cria um novo Conjunto de regras a partir da origem especificada e o aplica a um bucket do Cloud Storage.

SecurityRules.app

Assinatura:

readonly app: App;

SecurityRules.createRuleset()

Cria um novo Ruleset do RulesFile especificado.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
arquivo	RulesFile (link em inglês)	Arquivo de regras a ser incluído no novo Ruleset.

Retorna:

Promessa<Conjunto de regras>

Uma promessa que é cumprida com a recém-criada Ruleset.

SecurityRules.createRulesFileFromSource()

Cria um RulesFile com o nome e a origem fornecidos. Um erro será exibido se algum dos argumentos for inválido. Essa é uma operação local e não envolve chamadas de API de rede.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
name	string	Nome a atribuir ao arquivo de regras. Geralmente, é um nome curto que ajuda a identificar o arquivo em um conjunto de regras.
source	string | Tempo extra	Conteúdo do arquivo de regras.

Retorna:

RulesFile (link em inglês)

Uma nova instância de arquivo de regras.

Exemplo

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

SecurityRules.deleteRuleset()

Exclui o Conjunto de regras identificado pelo nome fornecido. O nome da entrada precisa ser a string de nome curta sem o prefixo do ID do projeto. Por exemplo, para excluir a projects/project-id/rulesets/my-ruleset, transmita o nome curto "my-ruleset". Rejeita com um erro not-found se o Ruleset especificado não puder ser encontrado.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
name	string	Nome do Ruleset a ser excluído.

Retorna:

Promessa<void>

Uma promessa que será atendida quando a Ruleset for excluída.

SecurityRules.getFirestoreRuleset()

Recebe o Conjunto de regras atualmente aplicado ao Cloud Firestore. Rejeita com um erro not-found se nenhum conjunto de regras for aplicado no Firestore.

Assinatura:

getFirestoreRuleset(): Promise<Ruleset>;

Retorna:

Promessa<Conjunto de regras>

Uma promessa que será atendida com o conjunto de regras do Firestore.

SecurityRules.getRuleset()

Recebe o Ruleset identificado pelo nome fornecido. O nome da entrada precisa ser a string de nome curta sem o prefixo do ID do projeto. Por exemplo, para recuperar a projects/project-id/rulesets/my-ruleset, transmita o nome curto "my-ruleset". Rejeita com um erro not-found se o Ruleset especificado não puder ser encontrado.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
name	string	Nome do Ruleset a ser recuperado.

Retorna:

Promessa<Conjunto de regras>

Uma promessa que é atendida com o Ruleset especificado.

SecurityRules.getStorageRuleset()

Recebe o Conjunto de regras atualmente aplicado a um bucket do Cloud Storage. Rejeita com um erro not-found se nenhum conjunto de regras for aplicado no bucket.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
bucket	string	Nome opcional do bucket do Cloud Storage a ser recuperado. Se não for especificado, recupera o conjunto de regras aplicado no bucket padrão configurado via AppOptions.

Retorna:

Promessa<Conjunto de regras>

Uma promessa que será atendida com o conjunto de regras do Cloud Storage.

SecurityRules.listRulesetMetadata()

Recupera uma página de metadados do conjunto de regras.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
pageSize	number	O tamanho da página, 100, se indefinido. Esse também é o limite máximo permitido.
nextPageToken	string	O token da próxima página. Se não for especificado, retorna conjuntos de regras que começam sem deslocamento.

Retorna:

Promessa<RulesetMetadataList>

Uma promessa que é atendida com uma página de conjuntos de regras.

SecurityRules.releaseFirestoreRuleset()

Aplica o conjunto de regras Ruleset especificado ao Cloud Firestore.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
conjunto de regras	string | RulesetMetadata (em inglês)	Nome do conjunto de regras a ser aplicado ou um objeto RulesetMetadata contendo o nome.

Retorna:

Promessa<void>

Uma promessa que será atendida quando o conjunto de regras for liberado.

SecurityRules.releaseFirestoreRulesetFromSource()

Cria um novo Ruleset da origem especificada e o aplica ao Cloud Firestore.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
source	string | Tempo extra	Origem das regras a serem aplicadas.

Retorna:

Promessa<Conjunto de regras>

Uma promessa que será atendida quando o conjunto de regras for criado e liberado.

SecurityRules.releaseStorageRuleset()

Aplica o conjunto de regras Ruleset especificado a um bucket do Cloud Storage.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
conjunto de regras	string | RulesetMetadata (em inglês)	Nome do conjunto de regras a ser aplicado ou um objeto RulesetMetadata contendo o nome.
bucket	string	Nome opcional do bucket do Cloud Storage em que as regras serão aplicadas. Se não for especificado, aplica o conjunto de regras no bucket padrão configurado por meio de AppOptions.

Retorna:

Promessa<void>

Uma promessa que será atendida quando o conjunto de regras for liberado.

SecurityRules.releaseStorageRulesetFromSource()

Cria um novo Conjunto de regras a partir da origem especificada e o aplica a um bucket do Cloud Storage.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
source	string | Tempo extra	Origem das regras a serem aplicadas.
bucket	string	Nome opcional do bucket do Cloud Storage em que as regras serão aplicadas. Se não for especificado, aplica o conjunto de regras no bucket padrão configurado por meio de AppOptions.

Retorna:

Promessa<Conjunto de regras>

Uma promessa que será atendida quando o conjunto de regras for criado e liberado.