Firebase SecurityRules
hizmet arayüzü.
İmza:
export declare class SecurityRules
Özellikler
Mülk | Değiştiriciler | Tip | Tanım |
---|---|---|---|
uygulama | Uygulama |
Yöntemler
Yöntem | Değiştiriciler | Tanım |
---|---|---|
createRuleset(dosya) | Verilen Kural Dosyasından yeni bir Kural Kümesi oluşturur . | |
createRulesFileFromSource(ad, kaynak) | Verilen ad ve kaynakla bir RulesFile oluşturur. Bağımsız değişkenlerden herhangi biri geçersizse hata atar. Bu yerel bir işlemdir ve herhangi bir ağ API çağrısını içermez. | |
deleteRuleset(isim) | Verilen adla tanımlanan Kural Kümesini siler. Giriş adı, proje kimliği öneki olmadan kısa ad dizesi olmalıdır. Örneğin, projects/project-id/rulesets/my-ruleset silmek için "kural kümem" kısa adını iletin. Belirtilen Ruleset bulunamazsa, not-found hatasıyla reddeder. | |
getFirestoreRuleset() | Şu anda Cloud Firestore'a uygulanan Kural Kümesini alır. Firestore'da hiçbir kural kümesi uygulanmadıysa not-found hatasıyla reddeder. | |
getRuleset(isim) | Verilen adla tanımlanan Kural Kümesini alır. Giriş adı, proje kimliği öneki olmadan kısa ad dizesi olmalıdır. Örneğin, projects/project-id/rulesets/my-ruleset almak için "kural kümem" kısa adını iletin. Belirtilen Ruleset bulunamazsa, not-found hatasıyla reddeder. | |
getStorageRuleset(kova) | Şu anda bir Cloud Storage paketine uygulanan Kural Kümesini alır. Pakette hiçbir kural kümesi uygulanmadıysa not-found hatasıyla reddeder. | |
listRulesetMetadata(pageSize, nextPageToken) | Kural kümesi meta verilerinin bir sayfasını alır. | |
ReleaseFirestoreRuleset(kural kümesi) | Belirtilen Kural Kümesi kural kümesini Cloud Firestore'a uygular. | |
ReleaseFirestoreRulesetFromSource(kaynak) | Verilen kaynaktan yeni bir Kural Kümesi oluşturur ve bunu Cloud Firestore'a uygular. | |
ReleaseStorageRuleset(kural kümesi, paket) | Belirtilen Kural Kümesi kural kümesini bir Cloud Storage paketine uygular. | |
ReleaseStorageRulesetFromSource(kaynak, paket) | Belirtilen kaynaktan yeni bir Kural Kümesi oluşturur ve bunu bir Cloud Storage paketine uygular. |
SecurityRules.app
İmza:
readonly app: App;
SecurityRules.createRuleset()
Verilen Kural Dosyasından yeni bir Kural Kümesi oluşturur .
İmza:
createRuleset(file: RulesFile): Promise<Ruleset>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
dosya | KurallarDosyası | Yeni Ruleset Kümesine dahil edilecek kurallar dosyası. |
İadeler:
Söz< Kural Seti >
Yeni oluşturulan Ruleset
ile yerine getirilen bir söz .
SecurityRules.createRulesFileFromSource()
Verilen ad ve kaynakla bir RulesFile oluşturur. Bağımsız değişkenlerden herhangi biri geçersizse hata atar. Bu yerel bir işlemdir ve herhangi bir ağ API çağrısını içermez.
İmza:
createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
isim | sicim | Kurallar dosyasına atanacak ad. Bu genellikle bir kural kümesindeki dosyayı tanımlamaya yardımcı olan kısa bir dosya adıdır. |
kaynak | dize | Tampon | Kurallar dosyasının içeriği. |
İadeler:
Yeni bir kural dosyası örneği.
Örnek
const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
'firestore.rules', source);
SecurityRules.deleteRuleset()
Verilen adla tanımlanan Kural Kümesini siler. Giriş adı, proje kimliği öneki olmadan kısa ad dizesi olmalıdır. Örneğin, projects/project-id/rulesets/my-ruleset
silmek için , "kural kümem" kısa adını iletin. Belirtilen Ruleset
bulunamazsa, not-found
hatasıyla reddeder.
İmza:
deleteRuleset(name: string): Promise<void>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
isim | sicim | Silinecek Ruleset adı. |
İadeler:
Söz<void>
Ruleset
silindiğinde yerine getirilen bir söz.
SecurityRules.getFirestoreRuleset()
Şu anda Cloud Firestore'a uygulanan Kural Kümesini alır. Firestore'da hiçbir kural kümesi uygulanmadıysa not-found
hatasıyla reddeder.
İmza:
getFirestoreRuleset(): Promise<Ruleset>;
İadeler:
Söz< Kural Seti >
Firestore kural kümesini yerine getiren bir söz.
SecurityRules.getRuleset()
Verilen adla tanımlanan Kural Kümesini alır. Giriş adı, proje kimliği öneki olmadan kısa ad dizesi olmalıdır. Örneğin, projects/project-id/rulesets/my-ruleset
almak için , "kural kümem" kısa adını iletin. Belirtilen Ruleset
bulunamazsa, not-found
hatasıyla reddeder.
İmza:
getRuleset(name: string): Promise<Ruleset>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
isim | sicim | Alınacak Ruleset adı. |
İadeler:
Söz< Kural Seti >
Belirtilen Ruleset
yerine getiren bir söz .
SecurityRules.getStorageRuleset()
Şu anda bir Cloud Storage paketine uygulanan Kural Kümesini alır. Pakette hiçbir kural kümesi uygulanmadıysa not-found
hatasıyla reddeder.
İmza:
getStorageRuleset(bucket?: string): Promise<Ruleset>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
Kova | sicim | Alınacak Cloud Storage paketinin isteğe bağlı adı. Belirtilmezse AppOptions aracılığıyla yapılandırılan varsayılan pakette uygulanan kural kümesini alır. |
İadeler:
Söz< Kural Seti >
Cloud Storage kural kümesiyle yerine getirilen bir söz.
SecurityRules.listRulesetMetadata()
Kural kümesi meta verilerinin bir sayfasını alır.
İmza:
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
sayfa boyutu | sayı | Sayfa boyutu, tanımlanmamışsa 100. Bu aynı zamanda izin verilen maksimum sınırdır. |
nextPageToken | sicim | Sonraki sayfa jetonu. Belirtilmezse herhangi bir uzaklık olmadan başlayan kural kümelerini döndürür. |
İadeler:
Söz< RulesetMetadataList >
Bir sayfa dolusu kural seti ile yerine getirilen bir söz.
SecurityRules.releaseFirestoreRuleset()
Belirtilen Kural Kümesi kural kümesini Cloud Firestore'a uygular.
İmza:
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
kural seti | dize | Kural KümesiMeta Verileri | Uygulanacak kural kümesinin adı veya adı içeren RulesetMetadata nesnesi. |
İadeler:
Söz<void>
Kural seti yayınlandığında yerine getirilen bir söz.
SecurityRules.releaseFirestoreRulesetFromSource()
Verilen kaynaktan yeni bir Kural Kümesi oluşturur ve bunu Cloud Firestore'a uygular.
İmza:
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
kaynak | dize | Tampon | Uygulanacak kural kaynağı. |
İadeler:
Söz< Kural Seti >
Kural seti oluşturulduğunda ve yayınlandığında yerine getirilen bir söz.
SecurityRules.releaseStorageRuleset()
Belirtilen Kural Kümesi kural kümesini bir Cloud Storage paketine uygular.
İmza:
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
kural seti | dize | Kural KümesiMeta Verileri | Uygulanacak kural kümesinin adı veya adı içeren RulesetMetadata nesnesi. |
Kova | sicim | Kuralların uygulanacağı Cloud Storage paketinin isteğe bağlı adı. Belirtilmezse kural kümesini AppOptions aracılığıyla yapılandırılan varsayılan pakete uygular . |
İadeler:
Söz<void>
Kural seti yayınlandığında yerine getirilen bir söz.
SecurityRules.releaseStorageRulesetFromSource()
Belirtilen kaynaktan yeni bir Kural Kümesi oluşturur ve bunu bir Cloud Storage paketine uygular.
İmza:
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
kaynak | dize | Tampon | Uygulanacak kural kaynağı. |
Kova | sicim | Kuralların uygulanacağı Cloud Storage paketinin isteğe bağlı adı. Belirtilmezse kural kümesini AppOptions aracılığıyla yapılandırılan varsayılan pakete uygular . |
İadeler:
Söz< Kural Seti >
Kural seti oluşturulduğunda ve yayınlandığında yerine getirilen bir söz.