Antarmuka layanan Firebase SecurityRules
.
Tanda tangan:
export declare class SecurityRules
Properti
Properti | Pengubah | Jenis | Keterangan |
---|---|---|---|
aplikasi | Aplikasi |
Metode
metode | Pengubah | Keterangan |
---|---|---|
buatRuleset(file) | Membuat Ruleset baru dari RulesFile yang diberikan . | |
createRulesFileFromSource(nama, sumber) | Membuat RulesFile dengan nama dan sumber yang diberikan. Memunculkan kesalahan jika salah satu argumen tidak valid. Ini adalah operasi lokal, dan tidak melibatkan panggilan API jaringan apa pun. | |
deleteRuleset(nama) | Menghapus Ruleset yang diidentifikasi dengan nama yang diberikan. Nama masukan harus berupa string nama pendek tanpa awalan ID proyek. Misalnya, untuk menghapus projects/project-id/rulesets/my-ruleset , berikan nama pendek "my-ruleset". Menolak dengan kesalahan not-found jika Ruleset yang ditentukan tidak dapat ditemukan. | |
dapatkanFirestoreRuleset() | Mendapatkan Aturan yang saat ini diterapkan ke Cloud Firestore. Menolak dengan kesalahan not-found jika tidak ada aturan yang diterapkan di Firestore. | |
dapatkanRuleset(nama) | Mendapatkan Ruleset yang diidentifikasi dengan nama yang diberikan. Nama masukan harus berupa string nama pendek tanpa awalan ID proyek. Misalnya, untuk mengambil projects/project-id/rulesets/my-ruleset , berikan nama pendek "my-ruleset". Menolak dengan kesalahan not-found jika Ruleset yang ditentukan tidak dapat ditemukan. | |
getStorageRuleset(ember) | Mendapatkan Aturan yang saat ini diterapkan ke bucket Cloud Storage. Menolak dengan kesalahan not-found jika tidak ada aturan yang diterapkan pada bucket. | |
listRulesetMetadata(Ukuran halaman, NextPageToken) | Mengambil halaman metadata kumpulan aturan. | |
rilisFirestoreRuleset(aturan) | Menerapkan kumpulan aturan yang ditetapkan ke Cloud Firestore. | |
rilisFirestoreRulesetFromSource(sumber) | Membuat Ruleset baru dari sumber tertentu, dan menerapkannya ke Cloud Firestore. | |
rilisStorageRuleset(aturan, keranjang) | Menerapkan kumpulan aturan yang ditentukan ke bucket Cloud Storage. | |
rilisStorageRulesetFromSource(sumber, keranjang) | Membuat Ruleset baru dari sumber tertentu, dan menerapkannya ke bucket Cloud Storage. |
Aturan Keamanan.app
Tanda tangan:
readonly app: App;
Aturan Keamanan.createRuleset()
Membuat Ruleset baru dari RulesFile yang diberikan .
Tanda tangan:
createRuleset(file: RulesFile): Promise<Ruleset>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
mengajukan | File Aturan | File aturan yang akan disertakan dalam Ruleset baru. |
Pengembalian:
Janji< Aturan >
Sebuah janji yang dipenuhi dengan Ruleset
yang baru dibuat .
Aturan Keamanan.createRulesFileFromSource()
Membuat RulesFile dengan nama dan sumber yang diberikan. Memunculkan kesalahan jika salah satu argumen tidak valid. Ini adalah operasi lokal, dan tidak melibatkan panggilan API jaringan apa pun.
Tanda tangan:
createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
nama | rangkaian | Nama untuk ditetapkan ke file aturan. Ini biasanya merupakan nama file pendek yang membantu mengidentifikasi file dalam kumpulan aturan. |
sumber | tali | Penyangga | Isi file aturan. |
Pengembalian:
Contoh file aturan baru.
Contoh
const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
'firestore.rules', source);
Aturan Keamanan.deleteRuleset()
Menghapus Ruleset yang diidentifikasi dengan nama yang diberikan. Nama masukan harus berupa string nama pendek tanpa awalan ID proyek. Misalnya, untuk menghapus projects/project-id/rulesets/my-ruleset
, berikan nama pendek "peraturan saya". Menolak dengan kesalahan not-found
jika Ruleset
yang ditentukan tidak dapat ditemukan.
Tanda tangan:
deleteRuleset(name: string): Promise<void>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
nama | rangkaian | Nama Ruleset yang akan dihapus. |
Pengembalian:
Janji<batal>
Janji yang terpenuhi ketika Ruleset
dihapus.
Aturan Keamanan.getFirestoreRuleset()
Mendapatkan Aturan yang saat ini diterapkan ke Cloud Firestore. Menolak dengan kesalahan not-found
jika tidak ada aturan yang diterapkan di Firestore.
Tanda tangan:
getFirestoreRuleset(): Promise<Ruleset>;
Pengembalian:
Janji< Aturan >
Sebuah janji yang dipenuhi dengan aturan Firestore.
Aturan Keamanan.getRuleset()
Mendapatkan Ruleset yang diidentifikasi dengan nama yang diberikan. Nama masukan harus berupa string nama pendek tanpa awalan ID proyek. Misalnya, untuk mengambil projects/project-id/rulesets/my-ruleset
, berikan nama pendek "peraturan saya". Menolak dengan kesalahan not-found
jika Ruleset
yang ditentukan tidak dapat ditemukan.
Tanda tangan:
getRuleset(name: string): Promise<Ruleset>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
nama | rangkaian | Nama Ruleset yang akan diambil. |
Pengembalian:
Janji< Aturan >
Janji yang dipenuhi dengan Ruleset
yang ditentukan .
Aturan Keamanan.getStorageRuleset()
Mendapatkan Aturan yang saat ini diterapkan ke bucket Cloud Storage. Menolak dengan kesalahan not-found
jika tidak ada aturan yang diterapkan pada bucket.
Tanda tangan:
getStorageRuleset(bucket?: string): Promise<Ruleset>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
keranjang | rangkaian | Nama opsional bucket Cloud Storage yang akan diambil. Jika tidak ditentukan, ambil kumpulan aturan yang diterapkan pada bucket default yang dikonfigurasi melalui AppOptions . |
Pengembalian:
Janji< Aturan >
Sebuah janji yang dipenuhi dengan aturan Cloud Storage.
Aturan Keamanan.listRulesetMetadata()
Mengambil halaman metadata kumpulan aturan.
Tanda tangan:
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
ukuran halaman | nomor | Ukuran halaman, 100 jika tidak ditentukan. Ini juga merupakan batas maksimum yang diperbolehkan. |
berikutnyaPageToken | rangkaian | Token halaman berikutnya. Jika tidak ditentukan, mengembalikan kumpulan aturan yang dimulai tanpa offset apa pun. |
Pengembalian:
Janji< RulesetMetadataList >
Sebuah janji yang dipenuhi dengan halaman aturan.
SecurityRules.releaseFirestoreRuleset()
Menerapkan kumpulan aturan yang ditentukan ke Cloud Firestore.
Tanda tangan:
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
peraturan | tali | Metadata Aturan | Nama kumpulan aturan yang akan diterapkan atau objek RulesetMetadata yang berisi nama tersebut. |
Pengembalian:
Janji<batal>
Janji yang dipenuhi ketika aturan dirilis.
SecurityRules.releaseFirestoreRulesetFromSource()
Membuat Ruleset baru dari sumber tertentu, dan menerapkannya ke Cloud Firestore.
Tanda tangan:
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
sumber | tali | Penyangga | Sumber aturan untuk diterapkan. |
Pengembalian:
Janji< Aturan >
Sebuah janji yang dipenuhi ketika aturan dibuat dan dirilis.
Aturan Keamanan.releaseStorageRuleset()
Menerapkan kumpulan aturan yang ditentukan ke bucket Cloud Storage.
Tanda tangan:
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
peraturan | tali | Metadata Aturan | Nama kumpulan aturan yang akan diterapkan atau objek RulesetMetadata yang berisi nama tersebut. |
keranjang | rangkaian | Nama opsional bucket Cloud Storage tempat aturan diterapkan. Jika tidak ditentukan, terapkan aturan pada bucket default yang dikonfigurasi melalui AppOptions . |
Pengembalian:
Janji<batal>
Janji yang dipenuhi ketika aturan dirilis.
SecurityRules.releaseStorageRulesetFromSource()
Membuat Ruleset baru dari sumber tertentu, dan menerapkannya ke bucket Cloud Storage.
Tanda tangan:
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
Parameter
Parameter | Jenis | Keterangan |
---|---|---|
sumber | tali | Penyangga | Sumber aturan untuk diterapkan. |
keranjang | rangkaian | Nama opsional bucket Cloud Storage tempat aturan diterapkan. Jika tidak ditentukan, terapkan aturan pada bucket default yang dikonfigurasi melalui AppOptions . |
Pengembalian:
Janji< Aturan >
Sebuah janji yang dipenuhi ketika aturan dibuat dan dirilis.