Các lựa chọn cấu hình cho một hàm có thể áp dụng trong thời gian chạy.
Chữ ký:
export interface RuntimeOptions
Thuộc tính
| Tài sản | Loại | Mô tả |
|---|---|---|
| consumeAppCheckToken | 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. Giá trị mặc định là false. |
| thực thiAppCheck | boolean | Xác định xem Firebase AppCheck có được thực thi hay không. |
| chính sách về lỗi hỏng | Chính sách về lỗi | boolean | Chính sách không thành công 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. |
| ingressSettings | (loại INGRESS_SETTINGS_OPTIONS)[number] | Đặt lại giá trị | Chế độ cài đặt đầu vào kiểm soát nơi hàm này có thể được gọi. |
| người gọi | "công khai" | "riêng tư" | chuỗi | chuỗi[] | Trình gọi để thiết lập chế độ kiểm soát quyền truy cập vào các hàm https. |
| nhãn | Ghi <string, string> | Các nhãn người dùng để đặt cho hàm. |
| maxInstances | số | Biểu thức<number> | Đặt lại giá trị | Số lượng phiên bản thực tế tối đa được phép chạy song song. |
| bộ nhớ | (loại VALID_MEMORY_OPTIONS)[số] | Biểu thức<number> | Đặt lại giá trị | Dung lượng bộ nhớ cần phân bổ cho hàm. |
| minInstances | số | Biểu thức<number> | Đặt lại giá trị | Số thực thể thực tế tối thiểu sẽ chạy tại một thời điểm nhất định. |
| preserveExternalChanges | boolean | Kiểm soát việc cấu hình hàm được sửa đổi bên ngoài nguồn hàm có được giữ nguyên hay không. Giá trị mặc định là false. |
| bí mật | (chuỗi | SecretParam)[] | |
| serviceAccount | "mặc định" | chuỗi | Biểu thức<string> | Đặt lại giá trị | Tài khoản dịch vụ cụ thể để chạy hàm. |
| timeoutSeconds | số | Biểu thức<number> | Đặt lại giá trị | Thời gian chờ cho hàm tính bằng giây, các giá trị có thể là từ 0 đến 540. |
| vpcConnector | chuỗi | Biểu thức<string> | Đặt lại giá trị | Kết nối chức năng đám mây với trình kết nối VPC được chỉ định. |
| vpcConnectorEgressSettings | (loại VPC_EGRESS_SETTINGS_OPTIONS)[number] | Đặt lại giá trị | Chế độ cài đặt đầu ra cho trình kết 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. Giá trị mặc định là false.
Đặt giá trị này thành true để bật tính năng ngăn chặn hoạt động phát lại của tính năng 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. Những mã thông báo được xác định 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 mã đó được gửi đến dịch vụ Kiểm tra ứng dụng bằng cách đặt lựa chọn này thành true. Các mục đích sử dụng khác của mã thông báo này sẽ không sử dụng mã này.
Tính năng bảo vệ chống phát lại này yêu cầu thêm một lệnh gọi mạng đến phần phụ trợ của tính năng Kiểm tra ứng dụng và buộc ứng dụng phải có chứng thực mới từ những nhà cung cấp dịch vụ 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 tiềm năng của nhà cung cấp dịch vụ chứng thực nhanh hơn. Chỉ sử dụng tính năng này để bảo vệ các hoạt động có lưu lượng truy cập thấp, bảo mật nghiêm trọng hoặc tiêu tốn nhiều tài nguyên.
Tuỳ chọn này không ảnh hưởng đến tuỳ chọn enforceAppCheck. Việc đặt giá trị sau thành true sẽ khiến hàm có thể gọi tự động phản hồi bằng mã trạng thái 401 unauthorized (Không được phép) khi yêu cầu chứa mã thông báo Kiểm tra ứng dụng không hợp lệ. Khi yêu cầu chứa mã thông báo Kiểm tra ứng dụng hợp lệ nhưng đã được sử dụng, thì 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à truyền quá trình thực thi đến mã xử lý để đưa ra 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 bạn đặt chính sách này thành true, những yêu cầu có mã thông báo không hợp lệ sẽ tự động phản hồi bằng thông báo lỗi 401 (Chưa được uỷ quyền). Khi đặt là false, các yêu cầu có mã thông báo không hợp lệ sẽ đặt ngữ cảnh.app thành không xác định.
Chữ ký:
enforceAppCheck?: boolean;
RuntimeOptions.failurePolicy
Chính sách không thành công 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
Chế độ cài đặt đầu vào kiểm soát nơi hàm này có thể được gọi.
Chữ ký:
ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;
RuntimeOptions.Callbackr
Trình gọi để thiết lập chế độ kiểm soát quyền truy cập vào các hàm https.
Chữ ký:
invoker?: "public" | "private" | string | string[];
RuntimeOptions.labels
Nhãn người dùng để đặt cho hàm.
Chữ ký:
labels?: Record<string, string>;
RuntimeOptions.maxInstances
Số lượng 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
Dung lượng bộ nhớ cần phân bổ cho hàm.
Chữ ký:
memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;
RuntimeOptions.minInstances
Số thực thể thực tế tối thiểu sẽ chạy tại một thời điểm nhất định.
Các thực thể sẽ được tính phí phân bổ bộ nhớ và 10% mức phân bổ CPU khi ở trạng thái rảnh.
Chữ ký:
minInstances?: number | Expression<number> | ResetValue;
RuntimeOptions.preserveExternalChanges
Kiểm soát việc cấu hình hàm được sửa đổi bên ngoài nguồn hàm có được giữ nguyên hay không. Giá trị mặc định là false.
Khi cài đặt cấu hình có sẵn trong nền tảng cơ bản nhưng chưa có trong SDK Hàm Firebase, bạn nên đặt preserveExternalChanges thành true. Nếu không, khi SDK Hàm Firebase phát hành phiên bản SDK mới có hỗ trợ cấu hình bị thiếu, chế độ cài đặt được định cấu hình thủ công của hàm có thể vô tình bị xoá sạch.
Chữ ký:
preserveExternalChanges?: boolean;
RuntimeOptions.secrets
Chữ ký:
secrets?: (string | SecretParam)[];
RuntimeOptions.serviceAccount
Tài khoản dịch vụ cụ thể để chạy hàm.
Chữ ký:
serviceAccount?: "default" | string | Expression<string> | ResetValue;
RuntimeOptions.timeoutSeconds
Thời gian chờ cho hàm 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 trình kết nối VPC được chỉ định.
Chữ ký:
vpcConnector?: string | Expression<string> | ResetValue;
RuntimeOptions.vpcConnectionEgressSettings
Chế độ cài đặt đầu ra cho trình kết nối VPC.
Chữ ký:
vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;