Firebase SecurityRulesサービス インターフェイス。
サイン：
export declare class SecurityRules
プロパティ
| 財産 | 修飾子 | タイプ | 説明 |
|---|---|---|---|
| アプリ | アプリ |
メソッド
| 方法 | 修飾子 | 説明 |
|---|---|---|
| createRuleset(ファイル) | 指定されたRulesFileから新しいルールセットを作成します。 | |
| createRulesFileFromSource(名前, ソース) | 指定された名前とソースを使用してRulesFileを作成します。いずれかの引数が無効な場合は、エラーがスローされます。これはローカル操作であり、ネットワーク API 呼び出しは含まれません。 | |
| deleteルールセット(名前) | 指定された名前で識別されるルールセットを削除します。入力名は、プロジェクト ID プレフィックスのない短い名前文字列である必要があります。たとえば、 projects/project-id/rulesets/my-rulesetを削除するには、短い名前「my-ruleset」を渡します。指定されたRuleset見つからnot-foundエラーで拒否されます。 | |
| getFirestoreRuleset() | 現在 Cloud Firestore に適用されているルールセットを取得します。 Firestore にルールセットが適用されていない場合は、 not-foundエラーで拒否されます。 | |
| getルールセット(名前) | 指定された名前で識別されるルールセットを取得します。入力名は、プロジェクト ID プレフィックスのない短い名前文字列である必要があります。たとえば、 projects/project-id/rulesets/my-rulesetを取得するには、短い名前「my-ruleset」を渡します。指定されたRuleset見つからnot-foundエラーで拒否されます。 | |
| getStorageRuleset(バケット) | Cloud Storage バケットに現在適用されているルールセットを取得します。バケットにルールセットが適用されていない場合は、 not-foundエラーで拒否されます。 | |
| listRulesetMetadata(pageSize, nextPageToken) | ルールセットのメタデータのページを取得します。 | |
| releaseFirestoreRuleset(ルールセット) | 指定されたRulesetルールセットを Cloud Firestore に適用します。 | |
| releaseFirestoreRulesetFromSource(ソース) | 指定されたソースから新しいルールセットを作成し、Cloud Firestore に適用します。 | |
| releaseStorageRuleset(ルールセット、バケット) | 指定されたRulesetルールセットを Cloud Storage バケットに適用します。 | |
| releaseStorageRulesetFromSource(ソース、バケット) | 指定されたソースから新しいルールセットを作成し、それを Cloud Storage バケットに適用します。 |
セキュリティルール.app
サイン：
readonly app: App;
SecurityRules.createRuleset()
指定されたRulesFileから新しいルールセットを作成します。
サイン：
createRuleset(file: RulesFile): Promise<Ruleset>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ファイル | ルールファイル | 新しいRulesetに含めるルール ファイル。 |
戻り値：
プロミス<ルールセット>
新しく作成されたRulesetで果たされる約束。
SecurityRules.createRulesFileFromSource()
指定された名前とソースを使用してRulesFileを作成します。いずれかの引数が無効な場合は、エラーがスローされます。これはローカル操作であり、ネットワーク API 呼び出しは含まれません。
サイン：
createRulesFileFromSource(name: string, source: string | Buffer): RulesFile;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| 名前 | 弦 | ルールファイルに割り当てる名前。これは通常、ルールセット内のファイルを識別するのに役立つ短いファイル名です。 |
| ソース | 文字列 |バッファ | ルールファイルの内容。 |
戻り値：
新しいルール ファイル インスタンス。
例
const source = '// Some rules source';
const rulesFile = admin.securityRules().createRulesFileFromSource(
'firestore.rules', source);
SecurityRules.deleteRuleset()
指定された名前で識別されるルールセットを削除します。入力名は、プロジェクト ID プレフィックスのない短い名前文字列である必要があります。たとえば、 projects/project-id/rulesets/my-rulesetを削除するには、短い名前「my-ruleset」を渡します。指定されたRuleset見つからnot-foundエラーで拒否されます。
サイン：
deleteRuleset(name: string): Promise<void>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| 名前 | 弦 | 削除するRulesetの名前。 |
戻り値：
約束<無効>
Rulesetが削除されたときに実行される Promise。
SecurityRules.getFirestoreRuleset()
現在 Cloud Firestore に適用されているルールセットを取得します。 Firestore にルールセットが適用されていない場合は、 not-foundエラーで拒否されます。
サイン：
getFirestoreRuleset(): Promise<Ruleset>;
戻り値：
プロミス<ルールセット>
Firestore ルールセットで実現される約束。
SecurityRules.getRuleset()
指定された名前で識別されるルールセットを取得します。入力名は、プロジェクト ID プレフィックスのない短い名前文字列である必要があります。たとえば、 projects/project-id/rulesets/my-ruleset取得するには、短い名前「my-ruleset」を渡します。指定されたRuleset見つからnot-foundエラーで拒否されます。
サイン：
getRuleset(name: string): Promise<Ruleset>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| 名前 | 弦 | 取得するRulesetの名前。 |
戻り値：
プロミス<ルールセット>
指定されたRulesetで満たされる Promise 。
SecurityRules.getStorageRuleset()
Cloud Storage バケットに現在適用されているルールセットを取得します。バケットにルールセットが適用されていない場合は、 not-foundエラーで拒否されます。
サイン：
getStorageRuleset(bucket?: string): Promise<Ruleset>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| バケツ | 弦 | 取得する Cloud Storage バケットの名前 (オプション)。指定しない場合、 AppOptionsを介して構成されたデフォルトのバケットに適用されるルールセットを取得します。 |
戻り値：
プロミス<ルールセット>
Cloud Storage ルールセットで実現される約束。
SecurityRules.listRulesetMetadata()
ルールセットのメタデータのページを取得します。
サイン：
listRulesetMetadata(pageSize?: number, nextPageToken?: string): Promise<RulesetMetadataList>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ページサイズ | 番号 | ページ サイズ。未定義の場合は 100。これは最大許容値でもあります。 |
| nextPageトークン | 弦 | 次のページのトークン。指定しない場合、オフセットなしで始まるルールセットを返します。 |
戻り値：
Promise< RulesetMetadataList >
ルールセットのページで実現される約束。
SecurityRules.releaseFirestoreRuleset()
指定されたRulesetルールセットを Cloud Firestore に適用します。
サイン：
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ルールセット | 文字列 |ルールセットメタデータ | 適用するルールセットの名前、またはその名前を含むRulesetMetadataオブジェクト。 |
戻り値：
約束<無効>
ルールセットがリリースされたときに実行される約束。
SecurityRules.releaseFirestoreRulesetFromSource()
指定されたソースから新しいルールセットを作成し、Cloud Firestore に適用します。
サイン：
releaseFirestoreRulesetFromSource(source: string | Buffer): Promise<Ruleset>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ソース | 文字列 |バッファ | 適用するルールのソース。 |
戻り値：
プロミス<ルールセット>
ルールセットが作成およびリリースされるときに実行される約束。
SecurityRules.releaseStorageRuleset()
指定されたRulesetルールセットを Cloud Storage バケットに適用します。
サイン：
releaseStorageRuleset(ruleset: string | RulesetMetadata, bucket?: string): Promise<void>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ルールセット | 文字列 |ルールセットメタデータ | 適用するルールセットの名前、またはその名前を含むRulesetMetadataオブジェクト。 |
| バケツ | 弦 | ルールを適用する Cloud Storage バケットの名前 (オプション)。指定しない場合、 AppOptionsで設定されたデフォルトのバケットにルールセットが適用されます。 。 |
戻り値：
約束<無効>
ルールセットがリリースされたときに実行される約束。
SecurityRules.releaseStorageRulesetFromSource()
指定されたソースから新しいルールセットを作成し、それを Cloud Storage バケットに適用します。
サイン：
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ソース | 文字列 |バッファ | 適用するルールのソース。 |
| バケツ | 弦 | ルールを適用する Cloud Storage バケットの名前 (オプション)。指定しない場合、 AppOptionsで設定されたデフォルトのバケットにルールセットが適用されます。 。 |
戻り値：
プロミス<ルールセット>
ルールセットが作成およびリリースされるときに実行される約束。