SecurityRules class

Интерфейс службы Firebase SecurityRules .

Подпись:

export declare class SecurityRules

Характеристики

Свойство Модификаторы Тип Описание
приложение Приложение

Методы

Метод Модификаторы Описание
createRuleset (файл) Создает новый набор правил из данного файла правил. .
createRulesFileFromSource (имя, источник) Создает RulesFile с заданным именем и источником. Выдает ошибку, если какой-либо из аргументов недействителен. Это локальная операция, которая не требует каких-либо вызовов сетевых API.
удалитьRuleset(имя) Удаляет набор правил , определенный по данному имени. Входное имя должно представлять собой короткую строку имени без префикса идентификатора проекта. Например, чтобы удалить projects/project-id/rulesets/my-ruleset , передайте короткое имя «my-ruleset». Отклоняется с ошибкой not-found , если указанный Ruleset не найден.
getFirestoreRuleset() Получает набор правил , применяемый в данный момент к Cloud Firestore. Отклоняется с ошибкой not-found , если в Firestore не применяется набор правил.
getRuleset (имя) Получает набор правил , идентифицированный по заданному имени. Входное имя должно представлять собой короткую строку имени без префикса идентификатора проекта. Например, чтобы получить projects/project-id/rulesets/my-ruleset , передайте короткое имя «my-ruleset». Отклоняется с ошибкой not-found , если указанный Ruleset не найден.
getStorageRuleset (ведро) Получает набор правил , применяемый в данный момент к сегменту Cloud Storage. Отклоняется с ошибкой not-found , если к сегменту не применен набор правил.
listRulesetMetadata (pageSize, nextPageToken) Получает страницу метаданных набора правил.
ReleaseFirestoreRuleset (набор правил) Применяет указанный набор правил набора правил к Cloud Firestore.
ReleaseFirestoreRulesetFromSource (источник) Создает новый набор правил из заданного источника и применяет его к Cloud Firestore.
ReleaseStorageRuleset (набор правил, сегмент) Применяет указанный набор правил к сегменту Cloud Storage.
ReleaseStorageRulesetFromSource (источник, сегмент) Создает новый набор правил из заданного источника и применяет его к сегменту Cloud Storage.

SecurityRules.app

Подпись:

readonly app: App;

SecurityRules.createRuleset()

Создает новый набор правил из данного файла правил. .

Подпись:

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()

Удаляет набор правил , определенный по данному имени. Входное имя должно представлять собой короткую строку имени без префикса идентификатора проекта. Например, чтобы удалить projects/project-id/rulesets/my-ruleset , передайте короткое имя «my-ruleset». Отклоняется с ошибкой not-found , если указанный Ruleset не найден.

Подпись:

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

Параметры

Параметр Тип Описание
имя нить Имя Ruleset необходимо удалить.

Возврат:

Обещание<void>

Обещание, которое выполняется при удалении Ruleset .

SecurityRules.getFirestoreRuleset()

Получает набор правил , применяемый в данный момент к Cloud Firestore. Отклоняется с ошибкой not-found , если в Firestore не применяется набор правил.

Подпись:

getFirestoreRuleset(): Promise<Ruleset>;

Возврат:

Обещание< Набор правил >

Обещание, соответствующее набору правил Firestore.

SecurityRules.getRuleset()

Получает набор правил , идентифицированный по заданному имени. Входное имя должно представлять собой короткую строку имени без префикса идентификатора проекта. Например, чтобы получить projects/project-id/rulesets/my-ruleset , передайте короткое имя «my-ruleset». Отклоняется с ошибкой not-found , если указанный Ruleset не найден.

Подпись:

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

Параметры

Параметр Тип Описание
имя нить Имя Ruleset , который требуется получить.

Возврат:

Обещание< Набор правил >

Обещание, которое выполняется с указанным Ruleset .

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, если не определен. Это также максимально допустимый предел.
СледующийПейджТокен нить Токен следующей страницы. Если не указано, возвращает наборы правил, начиная без смещения.

Возврат:

Обещание < RulesetMetadataList >

Обещание, которое выполняется со страницей наборов правил.

SecurityRules.releaseFirestoreRuleset()

Применяет указанный набор правил набора правил к Cloud Firestore.

Подпись: 

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

Параметры

Параметр Тип Описание
набор правил строка | Набор правилМетаданные Имя применяемого набора правил или объект RulesetMetadata , содержащий это имя.

Возврат:

Обещание<void>

Обещание, которое выполняется после выпуска набора правил.

SecurityRules.releaseFirestoreRulesetFromSource()

Создает новый набор правил из заданного источника и применяет его к Cloud Firestore.

Подпись: 

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

Параметры

Параметр Тип Описание
источник строка | Буфер Источник правил, которые нужно применить.

Возврат:

Обещание< Набор правил >

Обещание, которое выполняется при создании и выпуске набора правил.

SecurityRules.releaseStorageRuleset()

Применяет указанный набор правил к сегменту Cloud Storage.

Подпись: 

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

Параметры

Параметр Тип Описание
набор правил строка | Метаданные набора правил Имя применяемого набора правил или объект RulesetMetadata , содержащий это имя.
ведро нить Необязательное имя сегмента Cloud Storage, к которому применяются правила. Если не указано, применяется набор правил к корзине по умолчанию, настроенной через AppOptions. .

Возврат:

Обещание<void>

Обещание, которое выполняется после выпуска набора правил.

SecurityRules.releaseStorageRulesetFromSource()

Создает новый набор правил из заданного источника и применяет его к сегменту Cloud Storage.

Подпись: 

releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;

Параметры

Параметр Тип Описание
источник строка | Буфер Источник правил, которые нужно применить.
ведро нить Необязательное имя сегмента Cloud Storage, к которому применяются правила. Если не указано, применяется набор правил к корзине по умолчанию, настроенной через AppOptions. .

Возврат:

Обещание< Набор правил >

Обещание, которое выполняется при создании и выпуске набора правил.