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配置的預設儲存桶。 |
返回:
承諾<規則集>
建立和發布規則集時履行的承諾。