A interface de serviço Firebase SecurityRules
.
Assinatura:
export declare class SecurityRules
Propriedades
Propriedade | Modificadores | Modelo | Descrição |
---|---|---|---|
aplicativo | Aplicativo |
Métodos
Método | Modificadores | Descrição |
---|---|---|
createRuleset(arquivo) | Cria um novo conjunto de regras do RulesFile fornecido . | |
createRulesFileFromSource(nome, fonte) | 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. | |
deleteRuleset(nome) | 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 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. | |
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. | |
getRuleset(nome) | 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 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. | |
getStorageRuleset(bucket) | 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. | |
listRulesetMetadata(pageSize, nextPageToken) | Recupera uma página de metadados do conjunto de regras. | |
releaseFirestoreRuleset(conjunto de regras) | Aplica o conjunto de regras do conjunto de regras especificado ao Cloud Firestore . | |
releaseFirestoreRulesetFromSource(source) | Cria um novo conjunto de regras da origem especificada e o aplica ao Cloud Firestore. | |
releaseStorageRuleset(conjunto de regras, bucket) | Aplica o conjunto de regras do conjunto de regras especificado a um bucket do Cloud Storage. | |
releaseStorageRulesetFromSource(origem, bucket) | Cria um novo conjunto de regras da origem especificada e o aplica a um bucket do Cloud Storage. |
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
Parâmetro | Modelo | Descrição |
---|---|---|
Arquivo | Arquivo de Regras | Arquivo de regras a ser incluído no novo conjunto de Ruleset . |
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
Parâmetro | Modelo | Descrição |
---|---|---|
nome | corda | Nome a ser atribuído ao arquivo de regras. Geralmente, é um nome de arquivo curto que ajuda a identificar o arquivo em um conjunto de regras. |
fonte | seqüência | Amortecedor | Conteúdo do arquivo de regras. |
Devoluções:
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
Parâmetro | Modelo | Descrição |
---|---|---|
nome | corda | Nome do conjunto de Ruleset a ser excluído. |
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
Parâmetro | Modelo | Descrição |
---|---|---|
nome | corda | Nome do conjunto de Ruleset a ser recuperado. |
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
Parâmetro | Modelo | Descrição |
---|---|---|
balde | corda | 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 por meio AppOptions . |
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
Parâmetro | Modelo | Descrição |
---|---|---|
tamanho da página | número | O tamanho da página, 100 se indefinido. Este também é o limite máximo permitido. |
nextPageToken | corda | O próximo token de página. Se não for especificado, retornará conjuntos de regras iniciando sem nenhum deslocamento. |
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
Parâmetro | Modelo | Descrição |
---|---|---|
conjunto de regras | seqüência | Conjunto de regrasMetadados | Nome do conjunto de regras a ser aplicado ou um objeto RulesetMetadata contendo o nome. |
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
Parâmetro | Modelo | Descrição |
---|---|---|
fonte | seqüência | Amortecedor | Fonte de regras a ser aplicada. |
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
Parâmetro | Modelo | Descrição |
---|---|---|
conjunto de regras | seqüência | Conjunto de regrasMetadados | Nome do conjunto de regras a ser aplicado ou um objeto RulesetMetadata contendo o nome. |
balde | corda | Nome opcional do bucket do Cloud Storage ao qual aplicar as regras. Se não for especificado, aplica o conjunto de regras no bucket padrão configurado por meio de AppOptions . |
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
Parâmetro | Modelo | Descrição |
---|---|---|
fonte | seqüência | Amortecedor | Fonte de regras a ser aplicada. |
balde | corda | Nome opcional do bucket do Cloud Storage ao qual aplicar as regras. Se não for especificado, aplica o conjunto de regras no bucket padrão configurado por meio de AppOptions . |
Devoluções:
Promessa< Conjunto de regras >
Uma promessa que é cumprida quando o conjunto de regras é criado e liberado.