RuntimeOptions interface

Opcje konfiguracji funkcji, które mają zastosowanie w czasie wykonywania.

Podpis:

export interface RuntimeOptions 

Nieruchomości

Nieruchomość Typ Opis
zużywajAppCheckToken wartość logiczna Określa, czy token Sprawdzania aplikacji Firebase jest używany na żądanie. Domyślnie jest to fałsz.
wymuszanieAppCheck wartość logiczna Określa, czy wymuszana jest funkcja Firebase AppCheck.
Polityka niepowodzeń Polityka dotycząca awarii | wartość logiczna Zasady dotyczące niepowodzeń funkcji, przy czym wartość logiczna true jest równoznaczna z udostępnieniem pustego obiektu ponownej próby.
Ustawienia wejściowe (typ INGRESS_SETTINGS_OPTIONS )[liczba] | Zresetuj wartość Ustawienia ruchu przychodzącego, które kontrolują, skąd można wywołać tę funkcję.
wywołujący „publiczny” | "prywatny" | ciąg | strunowy[] Invoker ustawiający kontrolę dostępu do funkcji https.
etykiety Rekord<ciąg, ciąg> Etykiety użytkownika do ustawienia dla funkcji.
maxInstancje numer | Wyrażenie <numer> | Zresetuj wartość Maksymalna liczba rzeczywistych instancji, które mogą działać równolegle.
pamięć (typ VALID_MEMORY_OPTIONS )[liczba] | Wyrażenie <numer> | Zresetuj wartość Ilość pamięci do przydzielenia dla funkcji.
minInstancje numer | Wyrażenie <numer> | Zresetuj wartość Minimalna liczba rzeczywistych instancji, które mają być uruchomione w danym momencie.
zachowaj zmiany zewnętrzne wartość logiczna Kontroluje, czy zachowywana jest konfiguracja funkcji zmodyfikowana poza źródłem funkcji. Domyślnie jest to fałsz.
tajniki (ciąg | SecretParam)[]
konto serwisowe "domyślny" | ciąg | Wyrażenie <ciąg> | Zresetuj wartość Określone konto usługi, na którym ma działać funkcja.
limit czasuSekundy numer | Wyrażenie <numer> | Zresetuj wartość Limit czasu dla funkcji w sekundach, możliwe wartości to 0 do 540.
złącze vpc ciąg | Wyrażenie <ciąg> | Zresetuj wartość Połącz funkcję chmury z określonym złączem VPC.
Ustawienia vpcConnectorEgress (typ VPC_EGRESS_SETTINGS_OPTIONS )[liczba] | Zresetuj wartość Ustawienia wyjścia dla łącznika VPC.

RuntimeOptions.consumeAppCheckToken

Określa, czy token Sprawdzania aplikacji Firebase jest używany na żądanie. Domyślnie jest to fałsz.

Ustaw tę opcję na true, aby włączyć funkcję ochrony przed ponownym odtwarzaniem sprawdzania aplikacji poprzez wykorzystanie tokenu sprawdzania aplikacji na żądaniu, które można wywołać. W przypadku tokenów uznanych za już wykorzystane właściwość request.app.alreadyConsumed będzie miała ustawioną wartość true.

Tokeny uważa się za wykorzystane tylko wtedy, gdy zostaną wysłane do usługi sprawdzania aplikacji po ustawieniu tej opcji na wartość true. Inne zastosowania tokena nie powodują jego zużycia.

Ta funkcja ochrony przed powtarzaniem wymaga dodatkowego połączenia sieciowego z zapleczem App Check i zmusza klientów do uzyskania nowego zaświadczenia od wybranych dostawców zatwierdzeń. Może to zatem negatywnie wpłynąć na wydajność i potencjalnie szybciej wyczerpać limity dostawców atestów. Używaj tej funkcji tylko do ochrony małych ilości danych, krytycznych dla bezpieczeństwa lub kosztownych operacji.

Ta opcja nie ma wpływu na opcję enforceAppCheck . Ustawienie tej ostatniej na wartość true spowoduje, że wywoływana funkcja automatycznie odpowie kodem stanu 401 Nieautoryzowany, gdy żądanie zawiera nieprawidłowy token sprawdzania aplikacji. Jeśli żądanie zawiera ważne, ale wykorzystane tokeny sprawdzania aplikacji, żądania nie będą automatycznie odrzucane. Zamiast tego właściwość request.app.alreadyConsumed zostanie ustawiona na true i przekaże wykonanie do kodu obsługi w celu podjęcia dalszych decyzji, takich jak wymaganie dodatkowych kontroli bezpieczeństwa lub odrzucenie żądania.

Podpis:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Określa, czy wymuszana jest funkcja Firebase AppCheck.

Jeśli ma wartość true, żądania z nieprawidłowymi tokenami automatycznie odpowiadają błędem 401 (nieautoryzowany). W przypadku wartości false żądania z nieprawidłowymi tokenami ustawiają plik kontekstowy.app na nieodporny.

Podpis:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Zasady dotyczące niepowodzeń funkcji, przy czym wartość logiczna true jest równoznaczna z udostępnieniem pustego obiektu ponownej próby.

Podpis:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Ustawienia ruchu przychodzącego, które kontrolują, skąd można wywołać tę funkcję.

Podpis:

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

RuntimeOptions.invoker

Invoker ustawiający kontrolę dostępu do funkcji https.

Podpis:

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

Etykiety RuntimeOptions

Etykiety użytkownika do ustawienia dla funkcji.

Podpis:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

Maksymalna liczba rzeczywistych instancji, które mogą działać równolegle.

Podpis:

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

RuntimeOptions.pamięć

Ilość pamięci do przydzielenia dla funkcji.

Podpis:

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

RuntimeOptions.minInstances

Minimalna liczba rzeczywistych instancji, które mają być uruchomione w danym momencie.

Instancje będą rozliczane za alokację pamięci i 10% alokacji procesora w stanie bezczynności.

Podpis:

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

RuntimeOptions.preserveExternalChanges

Kontroluje, czy zachowywana jest konfiguracja funkcji zmodyfikowana poza źródłem funkcji. Domyślnie jest to fałsz.

Podczas ustawiania konfiguracji dostępnej na platformie podstawowej, która nie jest jeszcze dostępna w zestawie SDK funkcji Firebase, zdecydowanie zalecamy ustawienie parametru preserveExternalChanges na true . W przeciwnym razie, gdy zestaw SDK funkcji Firebase wypuści nową wersję zestawu SDK z obsługą brakującej konfiguracji, ręcznie skonfigurowane ustawienia funkcji mogą zostać przypadkowo usunięte.

Podpis:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Podpis:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Określone konto usługi, na którym ma działać funkcja.

Podpis:

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

RuntimeOptions.timeoutSeconds

Limit czasu dla funkcji w sekundach, możliwe wartości to 0 do 540.

Podpis:

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

RuntimeOptions.vpcConnector

Połącz funkcję chmury z określonym złączem VPC.

Podpis:

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

RuntimeOptions.vpcConnectorEgressSettings

Ustawienia wyjścia dla łącznika VPC.

Podpis:

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