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