Firebase SecurityRules
服务接口。
签名:
export declare class SecurityRules
特性
财产 | 修饰符 | 类型 | 描述 |
---|---|---|---|
应用程序 | 应用程序 |
方法
方法 | 修饰符 | 描述 |
---|---|---|
创建规则集(文件) | 从给定的规则文件创建新的规则集。 | |
createRulesFileFromSource(名称,源) | 使用给定名称和源创建一个RulesFile 。如果任何参数无效,则会引发错误。这是本地操作,不涉及任何网络API调用。 | |
删除规则集(名称) | 删除由给定名称标识的规则集。输入名称应该是不带项目 ID 前缀的短名称字符串。例如,要删除projects/project-id/rulesets/my-ruleset ,请传递短名称“my-ruleset”。如果not-found 指定的Ruleset 集,则拒绝并显示未找到错误。 | |
获取FirestoreRuleset() | 获取当前应用于 Cloud Firestore 的规则集。如果 Firestore 上未应用任何规则集,则会拒绝并显示not-found 错误。 | |
获取规则集(名称) | 获取由给定名称标识的规则集。输入名称应该是不带项目 ID 前缀的短名称字符串。例如,要检索projects/project-id/rulesets/my-ruleset ,请传递短名称“my-ruleset”。如果not-found 指定的Ruleset 集,则拒绝并显示未找到错误。 | |
获取存储规则集(桶) | 获取当前应用于 Cloud Storage 存储分区的规则集。如果没有在存储桶上应用规则集,则会拒绝并显示not-found 错误。 | |
listRulesetMetadata(pageSize, nextPageToken) | 检索规则集元数据页面。 | |
发布FirestoreRuleset(规则集) | 将指定的规则集应用到 Cloud Firestore。 | |
releaseFirestoreRulesetFromSource(源) | 从给定源创建新规则集,并将其应用到 Cloud Firestore。 | |
releaseStorageRuleset(规则集,存储桶) | 将指定的规则集应用到 Cloud Storage 存储桶。 | |
releaseStorageRulesetFromSource(源,存储桶) | 从给定源创建新规则集,并将其应用到 Cloud Storage 存储分区。 |
安全规则.app
签名:
readonly app: App;
SecurityRules.createRuleset()
签名:
createRuleset(file: RulesFile): Promise<Ruleset>;
参数
范围 | 类型 | 描述 |
---|---|---|
文件 | 规则文件 | 要包含在新Ruleset 规则文件。 |
返回:
承诺<规则集>
通过新创建的Ruleset
实现的承诺。
SecurityRules.createRulesFileFromSource()
使用给定名称和源创建一个RulesFile 。如果任何参数无效,则会引发错误。这是本地操作,不涉及任何网络API调用。
签名:
createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;
参数
范围 | 类型 | 描述 |
---|---|---|
姓名 | 细绳 | 分配给规则文件的名称。这通常是一个短文件名,有助于识别规则集中的文件。 |
来源 | 字符串|缓冲 | 规则文件的内容。 |
返回:
新的规则文件实例。
例子
const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
'firestore.rules', source);
SecurityRules.deleteRuleset()
删除由给定名称标识的规则集。输入名称应该是不带项目 ID 前缀的短名称字符串。例如,删除projects/project-id/rulesets/my-ruleset
,传递短名称“my-ruleset”。如果not-found
指定的Ruleset
集,则拒绝并显示未找到错误。
签名:
deleteRuleset(name: string): Promise<void>;
参数
范围 | 类型 | 描述 |
---|---|---|
姓名 | 细绳 | 要删除的Ruleset 的名称。 |
返回:
承诺<无效>
当Ruleset
被删除时履行的承诺。
SecurityRules.getFirestoreRuleset()
获取当前应用于 Cloud Firestore 的规则集。如果 Firestore 上未应用任何规则集,则会拒绝并显示not-found
错误。
签名:
getFirestoreRuleset(): Promise<Ruleset>;
返回:
承诺<规则集>
符合 Firestore 规则集的承诺。
SecurityRules.getRuleset()
获取由给定名称标识的规则集。输入名称应该是不带项目 ID 前缀的短名称字符串。例如,检索projects/project-id/rulesets/my-ruleset
,传递短名称“my-ruleset”。如果not-found
指定的Ruleset
集,则拒绝并显示未找到错误。
签名:
getRuleset(name: string): Promise<Ruleset>;
参数
范围 | 类型 | 描述 |
---|---|---|
姓名 | 细绳 | 要检索的Ruleset 的名称。 |
返回:
承诺<规则集>
满足指定Ruleset
的承诺。
SecurityRules.getStorageRuleset()
获取当前应用于 Cloud Storage 存储桶的规则集。如果没有在存储桶上应用规则集,则会拒绝并显示not-found
错误。
签名:
getStorageRuleset(bucket?: string): Promise<Ruleset>;
参数
范围 | 类型 | 描述 |
---|---|---|
桶 | 细绳 | 要检索的 Cloud Storage 存储桶的可选名称。如果未指定,则检索应用于通过AppOptions 配置的默认存储桶的规则集。 |
返回:
承诺<规则集>
云存储规则集兑现了这一承诺。
SecurityRules.listRulesetMetadata()
检索规则集元数据页面。
签名:
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
参数
范围 | 类型 | 描述 |
---|---|---|
页面大小 | 数字 | 页面大小,如果未定义则为 100。这也是允许的最大限制。 |
下一页令牌 | 细绳 | 下一页标记。如果未指定,则返回从没有任何偏移量开始的规则集。 |
返回:
Promise<规则集元数据列表>
一个通过一页规则集实现的承诺。
SecurityRules.releaseFirestoreRuleset()
将指定的规则集应用到 Cloud Firestore。
签名:
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
参数
范围 | 类型 | 描述 |
---|---|---|
规则集 | 字符串|规则集元数据 | 要应用的规则集的名称或包含该名称的RulesetMetadata 对象。 |
返回:
承诺<无效>
规则集发布时兑现的承诺。
SecurityRules.releaseFirestoreRulesetFromSource()
从给定源创建新规则集,并将其应用到 Cloud Firestore。
签名:
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
参数
范围 | 类型 | 描述 |
---|---|---|
来源 | 字符串|缓冲 | 要应用的规则来源。 |
返回:
承诺<规则集>
创建和发布规则集时履行的承诺。
SecurityRules.releaseStorageRuleset()
将指定的规则集应用到 Cloud Storage 存储桶。
签名:
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
参数
范围 | 类型 | 描述 |
---|---|---|
规则集 | 字符串|规则集元数据 | 要应用的规则集的名称或包含该名称的RulesetMetadata 对象。 |
桶 | 细绳 | 要应用规则的 Cloud Storage 存储桶的可选名称。如果未指定,则将规则集应用于通过AppOptions配置的默认存储桶。 |
返回:
承诺<无效>
规则集发布时兑现的承诺。
SecurityRules.releaseStorageRulesetFromSource()
从给定源创建新规则集,并将其应用到 Cloud Storage 存储分区。
签名:
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
参数
范围 | 类型 | 描述 |
---|---|---|
来源 | 字符串|缓冲 | 要应用的规则来源。 |
桶 | 细绳 | 要应用规则的 Cloud Storage 存储分区的可选名称。如果未指定,则将规则集应用于通过AppOptions配置的默认存储桶。 |
返回:
承诺<规则集>
创建和发布规则集时履行的承诺。