SecurityRules class

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

Chữ ký:

export declare class SecurityRules 

Thuộc tính

Phương thức

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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ố

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.