SecurityRules class

A interface de serviço Firebase SecurityRules .

Assinatura:

export declare class SecurityRules 

Propriedades

Métodos

SecurityRules.app

Assinatura:

readonly app: App;

SecurityRules.createRuleset()

Cria um novo conjunto de regras do RulesFile fornecido .

Assinatura:

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

Parâmetros

Devoluções:

Promessa< Conjunto de regras >

Uma promessa que cumpre com o conjunto de Ruleset recém-criado .

SecurityRules.createRulesFileFromSource()

Cria um RulesFile com o nome e a origem fornecidos. Lança um erro se algum dos argumentos for inválido. Esta é uma operação local e não envolve nenhuma chamada de API de rede.

Assinatura:

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

Parâmetros

Devoluções:

Arquivo de Regras

Uma nova instância do 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 de entrada deve ser a string de nome abreviado sem o prefixo do ID do projeto. Por exemplo, para excluir o arquivo projects/project-id/rulesets/my-ruleset , passe o nome curto "my-ruleset". Rejeita com um erro not-found se o conjunto de Ruleset especificado não puder ser encontrado.

Assinatura:

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

Parâmetros

Devoluções:

Promessa<void>

Uma promessa que é cumprida quando o Ruleset de regras é excluído.

SecurityRules.getFirestoreRuleset()

Obtém 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>;

Devoluções:

Promessa< Conjunto de regras >

Uma promessa que cumpre com o conjunto de regras do Firestore.

SecurityRules.getRuleset()

Obtém o conjunto de regras identificado pelo nome fornecido. O nome de entrada deve ser a string de nome abreviado sem o prefixo do ID do projeto. Por exemplo, para recuperar o arquivo projects/project-id/rulesets/my-ruleset , passe o nome curto "my-ruleset". Rejeita com um erro not-found se o conjunto de Ruleset especificado não puder ser encontrado.

Assinatura:

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

Parâmetros

Devoluções:

Promessa< Conjunto de regras >

Uma promessa que cumpre com o conjunto de Ruleset especificado .

SecurityRules.getStorageRuleset()

Obtém 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 ao bucket.

Assinatura:

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

Parâmetros

Devoluções:

Promessa< Conjunto de regras >

Uma promessa que cumpre 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

Devoluções:

Promessa< RulesetMetadataList >

Uma promessa que se cumpre com uma página de conjuntos de regras.

SecurityRules.releaseFirestoreRuleset()

Aplica o conjunto de regras do conjunto de regras especificado ao Cloud Firestore .

Assinatura:

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

Parâmetros

Devoluções:

Promessa<void>

Uma promessa que se cumpre quando o conjunto de regras é lançado.

SecurityRules.releaseFirestoreRulesetFromSource()

Cria um novo conjunto de regras da origem especificada e o aplica ao Cloud Firestore.

Assinatura:

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

Parâmetros

Devoluções:

Promessa< Conjunto de regras >

Uma promessa que é cumprida quando o conjunto de regras é criado e liberado.

SecurityRules.releaseStorageRuleset()

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

Assinatura:

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

Parâmetros

Devoluções:

Promessa<void>

Uma promessa que se cumpre quando o conjunto de regras é lançado.

SecurityRules.releaseStorageRulesetFromSource()

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

Assinatura:

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

Parâmetros

Devoluções:

Promessa< Conjunto de regras >

Uma promessa que é cumprida quando o conjunto de regras é criado e liberado.