SecurityRules class

Antarmuka layanan SecurityRules Firebase.

Tanda Tangan:

export declare class SecurityRules

Properti

Properti Pengubah Jenis Deskripsi
app Aplikasi

Metode

Metode Pengubah Deskripsi
createRuleset(file) Membuat Ruleset baru dari RulesFile yang ditentukan.
createRulesFileFromSource(nama, sumber) Membuat RulesFile dengan nama dan sumber yang diberikan. Menampilkan error jika ada argumen yang tidak valid. Ini adalah operasi lokal dan tidak melibatkan panggilan API jaringan apa pun.
deleteRuleset(nama) Menghapus Ruleset yang diidentifikasi berdasarkan nama tertentu. Nama input harus berupa string nama pendek tanpa awalan project ID. Misalnya, untuk menghapus projects/project-id/rulesets/my-ruleset, teruskan nama pendek "my-ruleset". Menolak dengan error not-found jika Ruleset yang ditentukan tidak dapat ditemukan.
getFirestoreRuleset() Mendapatkan Ruleset yang saat ini diterapkan ke Cloud Firestore. Menolak dengan error not-found jika tidak ada kumpulan aturan yang diterapkan di Firestore.
getRuleset(nama) Mendapatkan Ruleset yang diidentifikasi berdasarkan nama tertentu. Nama input harus berupa string nama pendek tanpa awalan project ID. Misalnya, untuk mengambil projects/project-id/rulesets/my-ruleset, teruskan nama pendek "my-ruleset". Menolak dengan error not-found jika Ruleset yang ditentukan tidak dapat ditemukan.
getStorageRuleset(bucket) Mendapatkan Ruleset yang saat ini diterapkan ke bucket Cloud Storage. Menolak dengan error not-found jika tidak ada kumpulan aturan yang diterapkan pada bucket.
listRulesetMetadata(pageSize, nextPageToken) Mengambil halaman metadata kumpulan aturan.
releaseFirestoreRuleset(ruleset) Menerapkan kumpulan aturan Ruleset yang ditentukan ke Cloud Firestore.
releaseFirestoreRulesetFromSource(sumber) Membuat Ruleset baru dari sumber tertentu, lalu menerapkannya ke Cloud Firestore.
releaseStorageRuleset(ruleset, bucket) Menerapkan kumpulan aturan Ruleset yang ditentukan ke bucket Cloud Storage.
releaseStorageRulesetFromSource(sumber, bucket) Membuat Ruleset baru dari sumber tertentu, dan menerapkannya ke bucket Cloud Storage.

SecurityRules.app

Tanda Tangan:

readonly app: App;

SecurityRules.createRuleset()

Membuat Ruleset baru dari RulesFile yang ditentukan.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
file RulesFile File aturan yang akan disertakan dalam Ruleset baru.

Hasil:

Promise<Ruleset>

Promise yang terpenuhi dengan Ruleset yang baru dibuat.

SecurityRules.createRulesFileFromSource()

Membuat RulesFile dengan nama dan sumber yang diberikan. Menampilkan error jika ada argumen yang 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 Deskripsi
name string Nama yang akan ditetapkan ke file aturan. Nama ini biasanya berupa nama file pendek yang membantu mengidentifikasi file dalam kumpulan aturan.
source rangkaian | Tambahan Konten file aturan.

Hasil:

RulesFile

Instance file aturan baru.

Contoh

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

SecurityRules.deleteRuleset()

Menghapus Ruleset yang diidentifikasi berdasarkan nama tertentu. Nama input harus berupa string nama pendek tanpa awalan project ID. Misalnya, untuk menghapus projects/project-id/rulesets/my-ruleset, teruskan nama pendek "my-ruleset". Menolak dengan error not-found jika Ruleset yang ditentukan tidak dapat ditemukan.

Tanda Tangan:

deleteRuleset(name: string): Promise<void>;

Parameter

Parameter Jenis Deskripsi
name string Nama Ruleset yang akan dihapus.

Hasil:

Janji<void>

Promise yang terpenuhi saat Ruleset dihapus.

SecurityRules.getFirestoreRuleset()

Mendapatkan Ruleset yang saat ini diterapkan ke Cloud Firestore. Menolak dengan error not-found jika tidak ada kumpulan aturan yang diterapkan di Firestore.

Tanda Tangan:

getFirestoreRuleset(): Promise<Ruleset>;

Hasil:

Promise<Ruleset>

Promise yang terpenuhi dengan kumpulan aturan Firestore.

SecurityRules.getRuleset()

Mendapatkan Ruleset yang diidentifikasi berdasarkan nama tertentu. Nama input harus berupa string nama pendek tanpa awalan project ID. Misalnya, untuk mengambil projects/project-id/rulesets/my-ruleset, teruskan nama pendek "my-ruleset". Menolak dengan error not-found jika Ruleset yang ditentukan tidak dapat ditemukan.

Tanda Tangan:

getRuleset(name: string): Promise<Ruleset>;

Parameter

Parameter Jenis Deskripsi
name string Nama Ruleset yang akan diambil.

Hasil:

Promise<Ruleset>

Promise yang terpenuhi dengan Ruleset yang ditentukan.

SecurityRules.getStorageRuleset()

Mendapatkan Ruleset yang saat ini diterapkan ke bucket Cloud Storage. Menolak dengan error not-found jika tidak ada kumpulan aturan yang diterapkan pada bucket.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
bucket string Nama opsional bucket Cloud Storage yang akan diambil. Jika tidak ditentukan, akan mengambil kumpulan aturan yang diterapkan pada bucket default yang dikonfigurasi melalui AppOptions.

Hasil:

Promise<Ruleset>

Promise yang terpenuhi dengan kumpulan aturan Cloud Storage.

SecurityRules.listRulesetMetadata()

Mengambil halaman metadata kumpulan aturan.

Tanda Tangan:

listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;

Parameter

Parameter Jenis Deskripsi
pageSize angka Ukuran halaman, 100 jika tidak ditentukan. Jumlah ini juga merupakan batas maksimum yang diizinkan.
nextPageToken string Token halaman berikutnya. Jika tidak ditentukan, akan menampilkan kumpulan aturan yang dimulai tanpa offset.

Hasil:

Promise<RulesetMetadataList>

Promise yang terpenuhi dengan satu halaman kumpulan aturan.

SecurityRules.releaseFirestoreRuleset()

Menerapkan kumpulan aturan Ruleset yang ditentukan ke Cloud Firestore.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
seperangkat aturan rangkaian | RulesetMetadata Nama kumpulan aturan yang akan diterapkan atau objek RulesetMetadata yang berisi nama.

Hasil:

Janji<void>

Promise yang terpenuhi saat kumpulan aturan dirilis.

SecurityRules.releaseFirestoreRulesetFromSource()

Membuat Ruleset baru dari sumber tertentu, lalu menerapkannya ke Cloud Firestore.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
source rangkaian | Tambahan Sumber aturan yang akan diterapkan.

Hasil:

Promise<Ruleset>

Promise yang terpenuhi saat kumpulan aturan dibuat dan dirilis.

SecurityRules.releaseStorageRuleset()

Menerapkan kumpulan aturan Ruleset yang ditentukan ke bucket Cloud Storage.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
seperangkat aturan rangkaian | RulesetMetadata Nama kumpulan aturan yang akan diterapkan atau objek RulesetMetadata yang berisi nama.
bucket string Nama opsional bucket Cloud Storage tempat aturan diterapkan. Jika tidak ditentukan, menerapkan kumpulan aturan pada bucket default yang dikonfigurasi melalui AppOptions.

Hasil:

Janji<void>

Promise yang terpenuhi saat kumpulan 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 Deskripsi
source rangkaian | Tambahan Sumber aturan yang akan diterapkan.
bucket string Nama opsional bucket Cloud Storage tempat aturan diterapkan. Jika tidak ditentukan, menerapkan kumpulan aturan pada bucket default yang dikonfigurasi melalui AppOptions.

Hasil:

Promise<Ruleset>

Promise yang terpenuhi saat kumpulan aturan dibuat dan dirilis.