Firebase SecurityRules 服務介面。
簽名：
export declare class SecurityRules
屬性
| 屬性 | 修飾符 | 類型 | 說明 |
|---|---|---|---|
| 應用程式 | 應用程式 |
方法
| 方法 | 修飾符 | 說明 |
|---|---|---|
| createRuleset(檔案) | 根據指定的 RulesFile 建立新的 Ruleset。 | |
| createRulesFileFromSource(名稱, 來源) | 使用指定名稱和來源建立 RulesFile。如果任何引數無效，就會擲回錯誤。此為本機作業，並未涉及任何網路 API 呼叫。 | |
| deleteRuleset(名稱) | 刪除以指定名稱識別的 Ruleset。輸入內容名稱應為不含專案 ID 前置字串的簡稱字串。例如，如要刪除 projects/project-id/rulesets/my-ruleset，請傳遞簡稱「my-ruleset」。如果找不到指定的Ruleset，則拒絕並顯示 not-found 錯誤。 |
|
| getFirestoreRuleset() | 取得目前套用至 Cloud Firestore 的 Ruleset。如果 Firestore 未套用任何規則集，拒絕並顯示 not-found 錯誤。 |
|
| getRuleset(名稱) | 取得指定名稱識別的 Ruleset。輸入內容名稱應為不含專案 ID 前置字串的簡稱字串。例如，如要擷取 projects/project-id/rulesets/my-ruleset，請傳遞簡稱「my-ruleset」。如果找不到指定的Ruleset，則拒絕並顯示 not-found 錯誤。 |
|
| getStorageRuleset(值區) | 取得目前套用至 Cloud Storage 值區的 Ruleset。如果值區未套用任何規則集，拒絕傳回 not-found 錯誤。 |
|
| listRulesetMetadata(pageSize, nextPageToken) | 擷取規則集中繼資料頁面。 | |
| releaseFirestoreRuleset(ruleset) | 將指定的 Ruleset 規則集套用至 Cloud Firestore。 | |
| releaseFirestoreRulesetFromSource(來源) | 從指定的來源建立新的 Ruleset，並套用至 Cloud Firestore。 | |
| releaseStorageRuleset(ruleset, bucket) | 將指定的 Ruleset 規則集套用至 Cloud Storage 值區。 | |
| releaseStorageRulesetFromSource(來源, 值區) | 從指定的來源建立新的 Ruleset，並套用至 Cloud Storage 值區。 |
SecurityRules.app
簽名：
readonly app: App;
SecurityRules.createRuleset()
簽名：
createRuleset(file: RulesFile): Promise<Ruleset>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 檔案 | 規則檔案 | 要納入新版 Ruleset 的規則檔案。 |
傳回：
Promise<規則集>
根據新建的 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()
刪除以指定名稱識別的 Ruleset。輸入內容名稱應為不含專案 ID 前置字串的簡稱字串。例如，如要刪除 projects/project-id/rulesets/my-ruleset，請傳遞簡稱「my-ruleset」。如果找不到指定的Ruleset，則拒絕並顯示 not-found 錯誤。
簽名：
deleteRuleset(name: string): Promise<void>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 名稱 | 字串 | 要刪除的 Ruleset 名稱。 |
傳回：
承諾<void>
在 Ruleset 刪除時履行的承諾。
SecurityRules.getFirestoreRuleset()
取得目前套用至 Cloud Firestore 的 Ruleset。如果 Firestore 未套用任何規則集，拒絕並顯示 not-found 錯誤。
簽名：
getFirestoreRuleset(): Promise<Ruleset>;
傳回：
Promise<規則集>
能履行 Firestore 規則集的承諾。
SecurityRules.getRuleset()
取得指定名稱識別的 Ruleset。輸入內容名稱應為不含專案 ID 前置字串的簡稱字串。例如，如要擷取 projects/project-id/rulesets/my-ruleset，請傳遞簡稱「my-ruleset」。如果找不到指定的Ruleset，則拒絕並顯示 not-found 錯誤。
簽名：
getRuleset(name: string): Promise<Ruleset>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 名稱 | 字串 | 要擷取的 Ruleset 名稱。 |
傳回：
Promise<規則集>
可實現指定 Ruleset 的承諾。
SecurityRules.getStorageRuleset()
取得目前套用至 Cloud Storage 值區的 Ruleset。如果值區未套用任何規則集，拒絕傳回 not-found 錯誤。
簽名：
getStorageRuleset(bucket?: string): Promise<Ruleset>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 值區 | 字串 | (選填) 要擷取的 Cloud Storage 值區名稱。如未指定，系統會擷取透過 AppOptions 設定的預設值區所套用的規則集。 |
傳回：
Promise<規則集>
能履行 Cloud Storage 規則集的承諾。
SecurityRules.listRulesetMetadata()
擷取規則集中繼資料頁面。
簽名：
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| pageSize | 數字 | 頁面大小，如未定義，則為 100。同時也是允許的上限。 |
| NextPageToken | 字串 | 下一頁符記。如未指定，則會傳回開頭為任何偏移規則的規則集。 |
傳回：
Promise<RulesetMetadataList>
利用規則集實現的承諾。
SecurityRules.releaseFirestoreRuleset()
將指定的 Ruleset 規則集套用至 Cloud Firestore。
簽名：
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 規則集 | 字串 |規則集中繼資料 | 要套用的規則集名稱，或包含名稱的 RulesetMetadata 物件。 |
傳回：
承諾<void>
會在規則集發布時實現的承諾。
SecurityRules.releaseFirestoreRulesetFromSource()
從指定的來源建立新的 Ruleset，並套用至 Cloud Firestore。
簽名：
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 來源 | 字串 |緩衝區 | 要套用的規則來源。 |
傳回：
Promise<規則集>
會在建立並釋出規則集時實現的承諾。
SecurityRules.releaseStorageRuleset()
將指定的 Ruleset 規則集套用至 Cloud Storage 值區。
簽名：
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 規則集 | 字串 |規則集中繼資料 | 要套用的規則集名稱，或包含名稱的 RulesetMetadata 物件。 |
| 值區 | 字串 | (選填) 要套用規則的 Cloud Storage 值區名稱。如果未指定，則會對透過 AppOptions 設定的預設值區套用規則集。 |
傳回：
承諾<void>
會在規則集發布時實現的承諾。
SecurityRules.releaseStorageRulesetFromSource()
從指定的來源建立新的 Ruleset，並套用至 Cloud Storage 值區。
簽名：
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 來源 | 字串 |緩衝區 | 要套用的規則來源。 |
| 值區 | 字串 | (選填) 要套用規則的 Cloud Storage 值區名稱。如果未指定，則會對透過 AppOptions 設定的預設值區套用規則集。 |
傳回：
Promise<規則集>
會在建立並釋出規則集時實現的承諾。