Firebase SecurityRules
서비스 인터페이스입니다.
서명:
export declare class SecurityRules
속성
재산 | 수정자 | 유형 | 설명 |
---|---|---|---|
앱 | 앱 |
행동 양식
방법 | 수정자 | 설명 |
---|---|---|
createRuleset(파일) | 지정된 RulesFile 에서 새 규칙 세트를 생성합니다. . | |
createRulesFileFromSource(이름, 소스) | 지정된 이름과 소스를 사용하여 RulesFile 을 만듭니다. 인수 중 하나라도 유효하지 않으면 오류가 발생합니다. 이는 로컬 작업이며 네트워크 API 호출을 포함하지 않습니다. | |
deleteRuleset(이름) | 지정된 이름으로 식별된 규칙 세트를 삭제합니다. 입력 이름은 프로젝트 ID 접두사가 없는 짧은 이름 문자열이어야 합니다. 예를 들어 projects/project-id/rulesets/my-ruleset 삭제하려면 짧은 이름 "my-ruleset"을 전달합니다. 지정된 Ruleset not-found 오류로 거부합니다. | |
getFirestoreRuleset() | 현재 Cloud Firestore에 적용된 규칙 세트를 가져옵니다. Firestore에 규칙 세트가 적용되지 않은 경우 not-found 오류로 거부됩니다. | |
getRuleset(이름) | 주어진 이름으로 식별되는 규칙 세트를 가져옵니다. 입력 이름은 프로젝트 ID 접두사가 없는 짧은 이름 문자열이어야 합니다. 예를 들어 projects/project-id/rulesets/my-ruleset 검색하려면 짧은 이름 "my-ruleset"을 전달합니다. 지정된 Ruleset not-found 오류로 거부합니다. | |
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()
지정된 RulesFile 에서 새 규칙 세트를 생성합니다. .
서명:
createRuleset(file: RulesFile): Promise<Ruleset>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
파일 | 규칙파일 | 새 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 의 이름입니다. |
보고:
약속<공허>
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 의 이름입니다. |
보고:
약속< 룰셋 >
지정된 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입니다. 이는 최대 허용 한도이기도 합니다. |
nextPage토큰 | 끈 | 다음 페이지 토큰입니다. 지정하지 않으면 오프셋 없이 시작하는 규칙 세트를 반환합니다. |
보고:
약속< RulesetMetadataList >
규칙 세트 페이지로 이행되는 약속입니다.
SecurityRules.releaseFirestoreRuleset()
지정된 규칙 세트 규칙 세트를 Cloud Firestore에 적용합니다.
서명:
releaseFirestoreRuleset(ruleset: string | RulesetMetadata): Promise<void>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
규칙 세트 | 문자열 | 규칙 세트메타데이터 | 적용할 규칙 세트의 이름 또는 이름이 포함된 RulesetMetadata 객체입니다. |
보고:
약속<공허>
규칙 세트가 출시되면 이행되는 약속입니다.
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를 통해 구성된 기본 버킷에 규칙 세트를 적용합니다. . |
보고:
약속<공허>
규칙 세트가 출시되면 이행되는 약속입니다.
SecurityRules.releaseStorageRulesetFromSource()
지정된 소스에서 새 규칙 세트를 만들고 이를 Cloud Storage 버킷에 적용합니다.
서명:
releaseStorageRulesetFromSource(source: string | Buffer, bucket?: string): Promise<Ruleset>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
원천 | 문자열 | 완충기 | 적용할 규칙 소스입니다. |
버킷 | 끈 | 규칙을 적용할 Cloud Storage 버킷의 선택적 이름입니다. 지정하지 않으면 AppOptions를 통해 구성된 기본 버킷에 규칙 세트를 적용합니다. . |
보고:
약속< 룰셋 >
규칙 세트가 생성되고 릴리스될 때 이행되는 약속입니다.