SecurityRules class

Giao diện dịch vụ Firebase SecurityRules .

Chữ ký:

export declare class SecurityRules

Của cải

Tài sản sửa đổi Kiểu Sự miêu tả
ứng dụng Ứng dụng

phương pháp

Phương pháp sửa đổi Sự miêu tả
createRuleset(file) Tạo một Bộ quy tắc mới từ RulesFile đã cho .
createRulesFileFromSource(tên, nguồn) Tạo một RulesFile với tên và nguồn đã cho. Đưa ra lỗi nếu bất kỳ đối số nào không hợp lệ. Đây là hoạt động cục bộ và không liên quan đến bất kỳ lệnh gọi API mạng nào.
xóaRuleset(tên) Xóa Bộ quy tắc được xác định theo tên đã cho. Tên đầu vào phải là chuỗi tên ngắn không có tiền tố ID dự án. Ví dụ: để xóa projects/project-id/rulesets/my-ruleset , hãy chuyển tên ngắn gọn "my-ruleset". Từ chối với lỗi not-found nếu không tìm thấy Ruleset được chỉ định.
getFirestoreRuleset() Nhận Bộ quy tắc hiện được áp dụng cho Cloud Firestore. Từ chối với lỗi not-found nếu không áp dụng bộ quy tắc nào trên Firestore.
getRuleset(tên) Lấy Bộ quy tắc được xác định theo tên đã cho. Tên đầu vào phải là chuỗi tên ngắn không có tiền tố ID dự án. Ví dụ: để truy xuất projects/project-id/rulesets/my-ruleset , hãy chuyển tên ngắn gọn "my-ruleset". Từ chối với lỗi not-found nếu không tìm thấy Ruleset được chỉ định.
getStorageRuleset(thùng) Lấy Bộ quy tắc hiện được áp dụng cho nhóm Lưu trữ đám mây. Từ chối với lỗi not-found nếu không có bộ quy tắc nào được áp dụng trên nhóm.
listRulesetMetadata(pageSize, nextPageToken) Truy xuất một trang siêu dữ liệu của bộ quy tắc.
phát hànhFirestoreRuleset(bộ quy tắc) Áp dụng bộ quy tắc Ruleset đã chỉ định cho Cloud Firestore.
phát hànhFirestoreRulesetFromSource(nguồn) Tạo Bộ quy tắc mới từ nguồn nhất định và áp dụng nó cho Cloud Firestore.
phát hànhStorageRuleset(bộ quy tắc, nhóm) Áp dụng bộ quy tắc Ruleset đã chỉ định cho bộ chứa Cloud Storage.
phát hànhStorageRulesetFromSource(nguồn, nhóm) Tạo một Bộ quy tắc mới từ nguồn đã cho và áp dụng nó vào bộ chứa Cloud Storage.

SecurityRules.app

Chữ ký:

readonly app: App;

SecurityRules.createRuleset()

Tạo một Bộ quy tắc mới từ RulesFile đã cho .

Chữ ký:

createRuleset(file: RulesFile): Promise<Ruleset>;

Thông số

Tham số Kiểu Sự miêu tả
tài liệu Tệp quy tắc Tệp quy tắc để đưa vào Ruleset mới .

Trả về:

Lời hứa< Bộ quy tắc >

Một lời hứa thực hiện với Ruleset mới được tạo .

SecurityRules.createRulesFileFromSource()

Tạo một RulesFile với tên và nguồn đã cho. Đưa ra lỗi nếu bất kỳ đối số nào không hợp lệ. Đây là hoạt động 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ố

Tham số Kiểu Sự miêu tả
tên sợi dây Tên để gán 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 | Đệm Nội dung của tập tin quy tắc.

Trả về:

Tệp quy tắc

Một phiên bản tệp quy tắc mới.

Ví dụ

const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
  'firestore.rules', source);

SecurityRules.deleteRuleset()

Xóa Bộ quy tắc được xác định theo tên đã cho. Tên đầu vào phải là chuỗi tên ngắn không có tiền tố ID dự án. Ví dụ: để xóa projects/project-id/rulesets/my-ruleset , chuyển tên ngắn "my-ruleset". 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ố

Tham số Kiểu Sự miêu tả
tên sợi dây Tên của Ruleset cần xóa.

Trả về:

Hứa<void>

Một lời hứa được thực hiện khi Ruleset bị xóa.

SecurityRules.getFirestoreRuleset()

Nhận Bộ quy tắc hiện được áp dụng cho Cloud Firestore. Từ chối với 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ả về:

Lời hứa< Bộ quy tắc >

Một lời hứa đáp ứng được bộ quy tắc Firestore.

SecurityRules.getRuleset()

Lấy Bộ quy tắc được xác định theo tên đã cho. Tên đầu vào phải là chuỗi tên ngắn không có tiền tố ID dự án. Ví dụ: để truy xuất projects/project-id/rulesets/my-ruleset , chuyển tên ngắn "my-ruleset". 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ố

Tham số Kiểu Sự miêu tả
tên sợi dây Tên của Ruleset cần truy xuất.

Trả về:

Lời hứa< Bộ quy tắc >

Một lời hứa thực hiện với Ruleset được chỉ định .

SecurityRules.getStorageRuleset()

Lấy Bộ quy tắc hiện được áp dụng cho nhóm Lưu trữ đám mây. Từ chối với lỗi not-found nếu không có bộ quy tắc nào được áp dụng trên nhóm.

Chữ ký:

getStorageRuleset(bucket?: string): Promise<Ruleset>;

Thông số

Tham số Kiểu Sự miêu tả
Gầu múc sợi dây Tên tùy chọn của nhóm Cloud Storage cần truy xuất. Nếu không được chỉ định, hãy truy xuất bộ quy tắc được áp dụng trên nhóm mặc định được định cấu hình qua AppOptions .

Trả về:

Lời hứa< Bộ quy tắc >

Một lời hứa thực hiện với bộ quy tắc 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ố

Tham số Kiểu Sự miêu tả
trangKích thước con 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 cho phép.
nextPageToken sợi dây Mã thông báo trang tiếp theo. Nếu không được chỉ định, trả về các bộ quy tắc bắt đầu mà không có bất kỳ phần bù nào.

Trả về:

Lời hứa< RulesetMetadataList >

Một lời hứa được thực hiện với một trang chứa các quy tắc.

SecurityRules.releaseFirestoreRuleset()

Áp dụng bộ quy tắc Ruleset đã chỉ định cho Cloud Firestore.

Chữ ký:

releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;

Thông số

Tham số Kiểu Sự miêu tả
bộ quy tắc chuỗi | Siêu dữ liệu quy tắc Tên của bộ quy tắc cần áp dụng hoặc đối tượng RulesetMetadata có chứa tên.

Trả về:

Hứa<void>

Một lời hứa được thực hiện khi bộ quy tắc được phát hành.

SecurityRules.releaseFirestoreRulesetFromSource()

Tạo Bộ quy tắc mới từ nguồn nhất định và áp dụng nó cho Cloud Firestore.

Chữ ký:

releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;

Thông số

Tham số Kiểu Sự miêu tả
nguồn chuỗi | Đệm Nguồn quy tắc để áp dụng.

Trả về:

Lời hứa< Bộ quy tắc >

Một lời hứa hoàn thành khi bộ quy tắc được tạo và phát hành.

SecurityRules.releaseStorageRuleset()

Áp dụng bộ quy tắc Ruleset đã chỉ định cho bộ chứa Cloud Storage.

Chữ ký:

releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;

Thông số

Tham số Kiểu Sự miêu tả
bộ quy tắc chuỗi | Siêu dữ liệu quy tắc Tên của bộ quy tắc cần áp dụng hoặc đối tượng RulesetMetadata có chứa tên.
Gầu múc sợi dây Tên tùy chọn của nhóm 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 nhóm mặc định được định cấu hình qua AppOptions .

Trả về:

Hứa<void>

Một lời hứa được thực hiện khi bộ quy tắc được phát hành.

SecurityRules.releaseStorageRulesetFromSource()

Tạo một Bộ quy tắc mới từ nguồn đã cho và áp dụng nó vào bộ chứa Cloud Storage.

Chữ ký:

releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;

Thông số

Tham số Kiểu Sự miêu tả
nguồn chuỗi | Đệm Nguồn quy tắc để áp dụng.
Gầu múc sợi dây Tên tùy chọn của nhóm 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 nhóm mặc định được định cấu hình qua AppOptions .

Trả về:

Lời hứa< Bộ quy tắc >

Một lời hứa hoàn thành khi bộ quy tắc được tạo và phát hành.