SecurityRules class

Firebase SecurityRules 서비스 인터페이스입니다.

서명:

export declare class SecurityRules 

속성

행동 양식

SecurityRules.app

서명:

readonly app: App;

SecurityRules.createRuleset()

지정된 RulesFile 에서 새 규칙 세트를 생성합니다. .

서명:

createRuleset(file: RulesFile): Promise<Ruleset>;

매개변수

보고:

약속< 룰셋 >

새로 생성된 Ruleset 이행하는 Promise .

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 삭제될 때 이행되는 약속입니다.

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 를 이행하는 약속 .

SecurityRules.getStorageRuleset()

현재 Cloud Storage 버킷에 적용된 규칙 세트를 가져옵니다. 버킷에 규칙 세트가 적용되지 않은 경우 not-found 오류로 거부합니다.

서명:

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

매개변수

보고:

약속< 룰셋 >

Cloud Storage 규칙 세트를 통해 이행되는 약속입니다.

SecurityRules.listRulesetMetadata()

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

서명:

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

매개변수

보고:

약속< RulesetMetadataList >

규칙 세트 페이지로 이행되는 약속입니다.

SecurityRules.releaseFirestoreRuleset()

지정된 규칙 세트 규칙 세트를 Cloud Firestore에 적용합니다.

서명:

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

매개변수

보고:

약속<공허>

규칙 세트가 출시되면 이행되는 약속입니다.

SecurityRules.releaseFirestoreRulesetFromSource()

지정된 소스에서 새 규칙 세트를 생성하여 Cloud Firestore에 적용합니다.

서명:

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

매개변수

보고:

약속< 룰셋 >

규칙 세트가 생성되고 릴리스될 때 이행되는 약속입니다.

SecurityRules.releaseStorageRuleset()

지정된 규칙 세트 규칙 세트를 Cloud Storage 버킷에 적용합니다.

서명:

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

매개변수

보고:

약속<공허>

규칙 세트가 출시되면 이행되는 약속입니다.

SecurityRules.releaseStorageRulesetFromSource()

지정된 소스에서 새 규칙 세트를 만들고 이를 Cloud Storage 버킷에 적용합니다.

서명:

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

매개변수

보고:

약속< 룰셋 >

규칙 세트가 생성되고 릴리스될 때 이행되는 약속입니다.