SecurityRules class

Firebase SecurityRules 서비스 인터페이스

서명:

export declare class SecurityRules 

속성

메소드

SecurityRules.app

서명:

readonly app: App;

SecurityRules.createRuleset()

지정된 RulesFile에서 새 Ruleset을 만듭니다.

서명:

createRuleset(file: RulesFile): Promise<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()

지정된 이름으로 식별된 Ruleset을 삭제합니다. 입력 이름은 프로젝트 ID 프리픽스가 없는 짧은 이름 문자열이어야 합니다. 예를 들어 projects/project-id/rulesets/my-ruleset을 삭제하려면 짧은 이름인 'my-ruleset'을 전달하세요. 지정된 Ruleset를 찾을 수 없는 경우 not-found 오류와 함께 거부됩니다.

서명:

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

매개변수

반환:

프로미스<void>

Ruleset가 삭제될 때 처리되는 프로미스입니다.

SecurityRules.getFirestoreRuleset()

현재 Cloud Firestore에 적용된 Ruleset을 가져옵니다. Firestore에 적용된 규칙 세트가 없으면 not-found 오류와 함께 거부됩니다.

서명:

getFirestoreRuleset(): Promise<Ruleset>;

반환:

프로미스 <규칙 세트>

Firestore 규칙 집합으로 처리하는 프로미스입니다.

SecurityRules.getRuleset()

지정된 이름으로 식별된 Ruleset을 가져옵니다. 입력 이름은 프로젝트 ID 프리픽스가 없는 짧은 이름 문자열이어야 합니다. 예를 들어 projects/project-id/rulesets/my-ruleset를 검색하려면 짧은 이름 'my-ruleset'을 전달합니다. 지정된 Ruleset를 찾을 수 없는 경우 not-found 오류와 함께 거부됩니다.

서명:

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

매개변수

반환:

프로미스 <규칙 세트>

지정된 Ruleset로 처리되는 프로미스입니다.

SecurityRules.getStorageRuleset()

현재 Cloud Storage 버킷에 적용된 Ruleset을 가져옵니다. 버킷에 적용된 규칙 세트가 없으면 not-found 오류와 함께 거부됩니다.

서명:

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

매개변수

반환:

프로미스 <규칙 세트>

Cloud Storage 규칙 세트로 처리되는 프로미스입니다.

SecurityRules.listRulesetMetadata()

규칙 세트 메타데이터의 페이지를 검색합니다.

서명:

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

매개변수

반환:

프로미스 <RulesetMetadataList>

규칙 집합의 페이지로 처리되는 프로미스입니다.

SecurityRules.releaseFirestoreRuleset()

지정된 Ruleset 규칙 집합을 Cloud Firestore에 적용합니다.

서명:

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

매개변수

반환:

프로미스<void>

규칙 세트가 해제될 때 처리되는 프로미스입니다.

SecurityRules.releaseFirestoreRulesetFromSource()

지정된 소스에서 새 Ruleset을 만들어 Cloud Firestore에 적용합니다.

서명:

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

매개변수

반환:

프로미스 <규칙 세트>

규칙 세트가 생성되고 해제될 때 처리되는 프로미스입니다.

SecurityRules.releaseStorageRuleset()

지정된 Ruleset 규칙 집합을 Cloud Storage 버킷에 적용합니다.

서명:

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

매개변수

반환:

프로미스<void>

규칙 세트가 해제될 때 처리되는 프로미스입니다.

SecurityRules.releaseStorageRulesetFromSource()

지정된 소스에서 새 Ruleset을 만들어 Cloud Storage 버킷에 적용합니다.

서명:

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

매개변수

반환:

프로미스 <규칙 세트>

규칙 세트가 생성되고 해제될 때 처리되는 프로미스입니다.