Giao diện dịch vụ Firebase SecurityRules.
Chữ ký:
export declare class SecurityRules
Thuộc tính
| Tài sản | Công cụ sửa đổi | Loại | Mô tả |
|---|---|---|---|
| ứng dụng | Ứng dụng |
Phương thức
| Phương thức | Công cụ sửa đổi | Mô tả |
|---|---|---|
| createRuleset(tệp) | Tạo một Ruleset mới từ RulesFile cho trước. | |
| createRulesFileFromSource(tên; nguồn) | Tạo một RulesFile (Tệp quy tắc) có tên và nguồn cho sẵn. Gửi thông báo lỗi nếu có bất kỳ đối số nào không hợp lệ. Đây là một thao tác cục bộ và không liên quan đến bất kỳ lệnh gọi API mạng nào. | |
| deleteRuleset(name) | Xoá Quy tắc được xác định theo tên cụ thể. Tên dữ liệu đầu vào phải là chuỗi tên ngắn không có tiền tố mã dự án. Ví dụ: để xoá projects/project-id/rulesets/my-ruleset, hãy chuyển tên ngắn "my-rulesset". Từ chối với lỗi not-found nếu không tìm thấy Ruleset được chỉ định. |
|
| getFirestoreRuleset() | Lấy Quy tắc hiện áp dụng cho Cloud Firestore. Từ chối nếu gặp lỗi not-found nếu không áp dụng bộ quy tắc nào trên Firestore. |
|
| getRuleset(name) | Lấy Ruleset (Quy tắc) được xác định theo tên cho sẵn. Tên dữ liệu đầu vào phải là chuỗi tên ngắn không có tiền tố mã dự án. Ví dụ: để truy xuất projects/project-id/rulesets/my-ruleset, hãy truyền tên ngắn "my-rulesset". Từ chối với lỗi not-found nếu không tìm thấy Ruleset được chỉ định. |
|
| getStorageRuleset(bộ chứa) | Lấy Quy tắc hiện được áp dụng cho bộ chứa Cloud Storage. Từ chối khi gặp lỗi not-found nếu không áp dụng bộ quy tắc nào trên bộ chứa. |
|
| listRulesetMetadata(pageSize, nextPageToken) | Truy xuất một trang siêu dữ liệu của bộ quy tắc. | |
| releaseFirestoreRuleset(bộ quy tắc) | Áp dụng bộ quy tắc Ruleset (Quy tắc) đã chỉ định cho Cloud Firestore. | |
| releaseFirestoreRulesetFromSource(nguồn) | Tạo một Quy tắc mới từ nguồn đã cho và áp dụng quy tắc đó cho Cloud Firestore. | |
| releaseStorageRuleset(bộ quy tắc, bộ chứa) | Áp dụng bộ quy tắc Quy tắc đã chỉ định cho một bộ chứa Cloud Storage. | |
| releaseStorageRulesetFromSource(nguồn, bộ chứa) | Tạo một Quy tắc mới từ nguồn đã cho và áp dụng quy tắc đó cho một bộ chứa Cloud Storage. |
SecurityRules.app
Chữ ký:
readonly app: App;
SecurityRules.createRuleset()
Tạo một Ruleset mới từ RulesFile cho trước.
Chữ ký:
createRuleset(file: RulesFile): Promise<Ruleset>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| tệp | RulesFile (Tệp quy tắc) | Tệp quy tắc cần đưa vào Ruleset mới. |
Trường hợp trả lại hàng:
Cam kết<Quy tắc>
Lời hứa sẽ thực hiện với Ruleset mới được tạo.
SecurityRules.createRulesFileFromSource()
Tạo một RulesFile (Tệp quy tắc) có tên và nguồn cho sẵn. Gửi thông báo lỗi nếu có bất kỳ đối số nào không hợp lệ. Đây là một thao tác cục bộ và không liên quan đến bất kỳ lệnh gọi API mạng nào.
Chữ ký:
createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| name | chuỗi | Tên để chỉ định cho tệp quy tắc. Đây thường là tên tệp ngắn giúp xác định tệp trong bộ quy tắc. |
| nguồn | chuỗi | Vùng đệm | Nội dung của tệp quy tắc. |
Trường hợp trả lại hàng:
RulesFile (Tệp quy tắc)
Bản sao tệp quy tắc mới.
Ví dụ
const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
'firestore.rules', source);
SecurityRules.deleteRuleset()
Xoá Quy tắc được xác định theo tên cụ thể. Tên dữ liệu đầu vào phải là chuỗi tên ngắn không có tiền tố mã dự án. Ví dụ: để xoá projects/project-id/rulesets/my-ruleset, hãy chuyển tên ngắn là "my-rulesset". Từ chối với lỗi not-found nếu không tìm thấy Ruleset được chỉ định.
Chữ ký:
deleteRuleset(name: string): Promise<void>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| name | chuỗi | Tên của Ruleset cần xoá. |
Trường hợp trả lại hàng:
Lời hứa<vô hiệu>
Lời hứa sẽ thực hiện khi Ruleset bị xoá.
SecurityRules.getFirestoreRuleset()
Lấy Quy tắc hiện áp dụng cho Cloud Firestore. Từ chối nếu gặp lỗi not-found nếu không áp dụng bộ quy tắc nào trên Firestore.
Chữ ký:
getFirestoreRuleset(): Promise<Ruleset>;
Trường hợp trả lại hàng:
Cam kết<Quy tắc>
Lời hứa sẽ thực hiện với bộ quy tắc Firestore.
SecurityRules.getRuleset()
Lấy Ruleset (Quy tắc) được xác định theo tên cho sẵn. Tên dữ liệu đầu vào phải là chuỗi tên ngắn không có tiền tố mã dự án. Ví dụ: để truy xuất projects/project-id/rulesets/my-ruleset, hãy chuyển tên ngắn "my-rulesset". Từ chối với lỗi not-found nếu không tìm thấy Ruleset được chỉ định.
Chữ ký:
getRuleset(name: string): Promise<Ruleset>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| name | chuỗi | Tên của Ruleset cần truy xuất. |
Trường hợp trả lại hàng:
Cam kết<Quy tắc>
Lời hứa thực hiện theo Ruleset đã chỉ định.
SecurityRules.getStorageRuleset()
Lấy Quy tắc hiện được áp dụng cho bộ chứa Cloud Storage. Từ chối khi gặp lỗi not-found nếu không áp dụng bộ quy tắc nào trên bộ chứa.
Chữ ký:
getStorageRuleset(bucket?: string): Promise<Ruleset>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| cái xô | chuỗi | Tên không bắt buộc của bộ chứa trong Cloud Storage cần truy xuất. Nếu không được chỉ định, hãy truy xuất bộ quy tắc áp dụng cho bộ chứa mặc định được định cấu hình qua AppOptions. |
Trường hợp trả lại hàng:
Cam kết<Quy tắc>
Lời hứa sẽ thực hiện với bộ quy tắc của Cloud Storage.
SecurityRules.listRulesetMetadata()
Truy xuất một trang siêu dữ liệu của bộ quy tắc.
Chữ ký:
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| pageSize | số | Kích thước trang, 100 nếu không xác định. Đây cũng là giới hạn tối đa được phép. |
| nextPageToken | chuỗi | Mã thông báo trang tiếp theo. Nếu không được chỉ định, hàm sẽ trả về tập hợp quy tắc bắt đầu mà không có chênh lệch. |
Trường hợp trả lại hàng:
Hứa hẹn<RulesetMetadataList>
Lời hứa được thực hiện bằng một trang quy tắc.
SecurityRules.releaseFirestoreRuleset()
Áp dụng bộ quy tắc Ruleset (Quy tắc) đã chỉ định cho Cloud Firestore.
Chữ ký:
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| bộ quy tắc | chuỗi | RulesetMetadata | Tên của bộ quy tắc sẽ áp dụng hoặc đối tượng RulesetMetadata có chứa tên. |
Trường hợp trả lại hàng:
Lời hứa<vô hiệu>
Lời hứa sẽ thực hiện khi bộ quy tắc được phát hành.
SecurityRules.releaseFirestoreRulesetFromSource()
Tạo một Quy tắc mới từ nguồn đã cho và áp dụng quy tắc đó cho Cloud Firestore.
Chữ ký:
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| nguồn | chuỗi | Vùng đệm | Nguồn quy tắc sẽ áp dụng. |
Trường hợp trả lại hàng:
Cam kết<Quy tắc>
Lời hứa sẽ thực hiện khi bộ quy tắc được tạo và phát hành.
SecurityRules.releaseStorageRuleset()
Áp dụng bộ quy tắc Quy tắc đã chỉ định cho một bộ chứa Cloud Storage.
Chữ ký:
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| bộ quy tắc | chuỗi | RulesetMetadata | Tên của bộ quy tắc sẽ áp dụng hoặc đối tượng RulesetMetadata có chứa tên. |
| cái xô | chuỗi | Tên không bắt buộc của bộ chứa Cloud Storage để áp dụng các quy tắc. Nếu không được chỉ định, hãy áp dụng bộ quy tắc trên bộ chứa mặc định được định cấu hình thông qua AppOptions. |
Trường hợp trả lại hàng:
Lời hứa<vô hiệu>
Lời hứa sẽ thực hiện khi bộ quy tắc được phát hành.
SecurityRules.releaseStorageRulesetFromSource()
Tạo một Quy tắc mới từ nguồn đã cho và áp dụng quy tắc đó cho một bộ chứa Cloud Storage.
Chữ ký:
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
Thông số
| Thông số | Loại | Mô tả |
|---|---|---|
| nguồn | chuỗi | Vùng đệm | Nguồn quy tắc sẽ áp dụng. |
| cái xô | chuỗi | Tên không bắt buộc của bộ chứa Cloud Storage để áp dụng các quy tắc. Nếu không được chỉ định, hãy áp dụng bộ quy tắc trên bộ chứa mặc định được định cấu hình thông qua AppOptions. |
Trường hợp trả lại hàng:
Cam kết<Quy tắc>
Lời hứa sẽ thực hiện khi bộ quy tắc được tạo và phát hành.