RuntimeOptions interface

Tùy chọn cấu hình cho chức năng có thể áp dụng trong thời gian chạy.

Chữ ký:

export interface RuntimeOptions 

Của cải

Tài sản	Kiểu	Sự miêu tả
tiêu thụAppCheckToken	boolean	Xác định xem mã thông báo Kiểm tra ứng dụng Firebase có được sử dụng theo yêu cầu hay không. Mặc định là sai.
thực thiAppCheck	boolean	Xác định xem Firebase AppCheck có được thực thi hay không.
chính sách thất bại	Chính sách thất bại | boolean	Chính sách lỗi của hàm, với boolean true tương đương với việc cung cấp một đối tượng thử lại trống.
xâm nhậpCài đặt	(loại INGRESS_SETTINGS_OPTIONS )[số] | Đặt lại giá trị	Cài đặt đầu vào kiểm soát nơi có thể gọi chức năng này.
kẻ triệu hồi	"công khai" | "riêng tư" | chuỗi | sợi dây[]	Invoker để thiết lập kiểm soát truy cập trên các chức năng https.
nhãn	Bản ghi<chuỗi, chuỗi>	Nhãn người dùng để đặt trên chức năng.
trường hợp tối đa	số | Sự biểu lộ <số> | Đặt lại giá trị	Số phiên bản thực tế tối đa được phép chạy song song.
ký ức	(loại VALID_MEMORY_OPTIONS )[số] | Sự biểu lộ <số> | Đặt lại giá trị	Lượng bộ nhớ để phân bổ cho hàm.
trường hợp tối thiểu	số | Sự biểu lộ <số> | Đặt lại giá trị	Số lượng phiên bản thực tế tối thiểu sẽ chạy tại một thời điểm nhất định.
bảo tồnThay đổi bên ngoài	boolean	Kiểm soát xem cấu hình chức năng được sửa đổi bên ngoài nguồn chức năng có được giữ nguyên hay không. Mặc định là sai.
bí mật	(chuỗi | SecretParam)[]
dịch vụTài khoản	"mặc định" | chuỗi | Sự biểu lộ <chuỗi> | Đặt lại giá trị	Tài khoản dịch vụ cụ thể để chức năng chạy dưới dạng.
hết thời gianGiây	số | Sự biểu lộ <số> | Đặt lại giá trị	Thời gian chờ của chức năng tính bằng giây, các giá trị có thể là từ 0 đến 540.
vpcConnector	chuỗi | Sự biểu lộ <chuỗi> | Đặt lại giá trị	Kết nối chức năng đám mây với đầu nối VPC được chỉ định.
vpcConnectorEgressSettings	(loại VPC_EGRESS_SETTINGS_OPTIONS )[số] | Đặt lại giá trị	Cài đặt đầu ra cho đầu nối VPC.

RuntimeOptions.consumeAppCheckToken

Xác định xem mã thông báo Kiểm tra ứng dụng Firebase có được sử dụng theo yêu cầu hay không. Mặc định là sai.

Đặt giá trị này thành true để bật tính năng bảo vệ chống phát lại Kiểm tra ứng dụng bằng cách sử dụng mã thông báo Kiểm tra ứng dụng theo yêu cầu có thể gọi được. Các mã thông báo được phát hiện là đã được sử dụng sẽ có thuộc tính request.app.alreadyConsumed được đặt thành true.

Mã thông báo chỉ được coi là được sử dụng nếu nó được gửi đến dịch vụ Kiểm tra ứng dụng bằng cách đặt tùy chọn này thành true. Các mục đích sử dụng khác của mã thông báo không tiêu tốn nó.

Tính năng bảo vệ chống lặp lại này yêu cầu một lệnh gọi mạng bổ sung tới phần phụ trợ Kiểm tra ứng dụng và buộc khách hàng phải có được chứng thực mới từ các nhà cung cấp chứng thực đã chọn. Do đó, điều này có thể tác động tiêu cực đến hiệu suất và có khả năng làm cạn kiệt hạn ngạch của nhà cung cấp chứng thực của bạn nhanh hơn. Chỉ sử dụng tính năng này để bảo vệ các hoạt động có khối lượng thấp, bảo mật quan trọng hoặc tốn kém.

Tùy chọn này không ảnh hưởng đến tùy chọn enforceAppCheck . Đặt giá trị sau thành true sẽ khiến hàm có thể gọi tự động phản hồi với mã trạng thái trái phép 401 khi yêu cầu bao gồm mã thông báo Kiểm tra ứng dụng không hợp lệ. Khi yêu cầu bao gồm mã thông báo Kiểm tra ứng dụng hợp lệ nhưng đã được sử dụng, yêu cầu sẽ không tự động bị từ chối. Thay vào đó, thuộc tính request.app.alreadyConsumed sẽ được đặt thành true và chuyển lệnh thực thi tới mã xử lý để đưa ra các quyết định tiếp theo, chẳng hạn như yêu cầu kiểm tra bảo mật bổ sung hoặc từ chối yêu cầu.

Chữ ký:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Xác định xem Firebase AppCheck có được thực thi hay không.

Khi đúng, các yêu cầu có mã thông báo không hợp lệ sẽ tự động phản hồi với lỗi 401 (Không được phép). Khi sai, các yêu cầu có mã thông báo không hợp lệ sẽ đặt context.app thành không xác định.

Chữ ký:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Chính sách lỗi của hàm, với boolean true tương đương với việc cung cấp một đối tượng thử lại trống.

Chữ ký:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Cài đặt đầu vào kiểm soát nơi có thể gọi chức năng này.

Chữ ký:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invoker

Invoker để thiết lập kiểm soát truy cập trên các chức năng https.

Chữ ký:

invoker?: "public" | "private" | string | string[];

RuntimeOptions.labels

Nhãn người dùng để đặt trên chức năng.

Chữ ký:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

Số phiên bản thực tế tối đa được phép chạy song song.

Chữ ký:

maxInstances?: number | Expression<number> | ResetValue;

RuntimeOptions.memory

Lượng bộ nhớ để phân bổ cho hàm.

Chữ ký:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

Số lượng phiên bản thực tế tối thiểu sẽ chạy tại một thời điểm nhất định.

Các phiên bản sẽ bị tính phí cho việc phân bổ bộ nhớ và 10% phân bổ CPU khi không hoạt động.

Chữ ký:

minInstances?: number | Expression<number> | ResetValue;

RuntimeOptions.preserveExternalChanges

Kiểm soát xem cấu hình chức năng được sửa đổi bên ngoài nguồn chức năng có được giữ nguyên hay không. Mặc định là sai.

Khi cài đặt cấu hình có sẵn trong nền tảng cơ bản chưa có trong SDK chức năng Firebase, chúng tôi khuyên bạn nên đặt preserveExternalChanges thành true . Mặt khác, khi SDK chức năng Firebase phát hành phiên bản SDK mới có hỗ trợ cấu hình bị thiếu, cài đặt được định cấu hình thủ công cho chức năng của bạn có thể vô tình bị xóa.

Chữ ký:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Chữ ký:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Tài khoản dịch vụ cụ thể để chức năng chạy dưới dạng.

Chữ ký:

serviceAccount?: "default" | string | Expression<string> | ResetValue;

RuntimeOptions.timeoutSeconds

Thời gian chờ của chức năng tính bằng giây, các giá trị có thể là từ 0 đến 540.

Chữ ký:

timeoutSeconds?: number | Expression<number> | ResetValue;

RuntimeOptions.vpcConnector

Kết nối chức năng đám mây với đầu nối VPC được chỉ định.

Chữ ký:

vpcConnector?: string | Expression<string> | ResetValue;

RuntimeOptions.vpcConnectorEgressSettings

Cài đặt đầu ra cho đầu nối VPC.

Chữ ký:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;