RuntimeOptions interface

Konfigurationsoptionen für eine Funktion, die zur Laufzeit anwendbar sind.

Unterschrift:

export interface RuntimeOptions

Eigenschaften

Eigentum Typ Beschreibung
verbrauchenAppCheckToken Boolescher Wert Bestimmt, ob das Firebase App Check-Token auf Anfrage verbraucht wird. Der Standardwert ist „false“.
erzwingeAppCheck Boolescher Wert Bestimmt, ob Firebase AppCheck erzwungen wird.
Fehlerrichtlinie Fehlerrichtlinie | Boolescher Wert Fehlerrichtlinie der Funktion, wobei der boolesche true der Bereitstellung eines leeren Wiederholungsobjekts entspricht.
IngressSettings (Typ von INGRESS_SETTINGS_OPTIONS )[Anzahl] | Wert zurücksetzen Eingangseinstellungen, die steuern, von wo aus diese Funktion aufgerufen werden kann.
Anrufer „öffentlich“ | „privat“ | Zeichenfolge | string[] Aufrufer zum Festlegen der Zugriffskontrolle für https-Funktionen.
Etiketten Record<string, string> Benutzerbezeichnungen, die für die Funktion festgelegt werden sollen.
maxInstances Nummer | Ausdruck <Nummer> | Wert zurücksetzen Maximale Anzahl tatsächlicher Instanzen, die parallel ausgeführt werden dürfen.
Erinnerung (Typ von VALID_MEMORY_OPTIONS )[Anzahl] | Ausdruck <Nummer> | Wert zurücksetzen Speichermenge, die der Funktion zugewiesen werden soll.
minInstanzen Nummer | Ausdruck <Nummer> | Wert zurücksetzen Mindestanzahl tatsächlicher Instanzen, die zu einem bestimmten Zeitpunkt ausgeführt werden sollen.
PreserveExternalChanges Boolescher Wert Steuert, ob die außerhalb der Funktionsquelle geänderte Funktionskonfiguration erhalten bleibt. Der Standardwert ist „false“.
Geheimnisse (string | SecretParam)[]
serviceAccount „Standard“ | Zeichenfolge | Ausdruck <string> | Wert zurücksetzen Spezifisches Dienstkonto, unter dem die Funktion ausgeführt werden soll.
timeoutSekunden Nummer | Ausdruck <Nummer> | Wert zurücksetzen Timeout für die Funktion in Sekunden, mögliche Werte sind 0 bis 540.
vpcConnector Zeichenfolge | Ausdruck <string> | Wert zurücksetzen Cloud-Funktion mit dem angegebenen VPC-Connector verbinden.
vpcConnectorEgressSettings (Typ von VPC_EGRESS_SETTINGS_OPTIONS )[Anzahl] | Wert zurücksetzen Ausgangseinstellungen für den VPC-Connector.

RuntimeOptions.consumeAppCheckToken

Bestimmt, ob das Firebase App Check-Token auf Anfrage verbraucht wird. Der Standardwert ist „false“.

Legen Sie dies auf „true“ fest, um die App Check-Wiedergabeschutzfunktion zu aktivieren, indem das App Check-Token bei aufrufbarer Anfrage genutzt wird. Für Token, die bereits verbraucht sind, wird die Eigenschaft request.app.alreadyConsumed “ auf „true“ gesetzt.

Token gelten nur dann als verbraucht, wenn sie an den App Check-Dienst gesendet werden, indem diese Option auf „true“ gesetzt wird. Andere Verwendungen des Tokens verbrauchen ihn nicht.

Diese Wiedergabeschutzfunktion erfordert einen zusätzlichen Netzwerkaufruf an das App Check-Backend und zwingt die Clients, eine neue Bescheinigung von den ausgewählten Bescheinigungsanbietern zu erhalten. Dies kann sich daher negativ auf die Leistung auswirken und die Kontingente Ihrer Attestierungsanbieter möglicherweise schneller erschöpfen. Verwenden Sie diese Funktion nur zum Schutz von Vorgängen mit geringem Volumen, sicherheitskritischen oder teuren Vorgängen.

Diese Option hat keinen Einfluss auf die Option enforceAppCheck . Wenn Sie Letzteres auf „true“ setzen, antwortet die aufrufbare Funktion automatisch mit dem Statuscode „401 Unauthorized“, wenn die Anfrage ein ungültiges App Check-Token enthält. Wenn die Anfrage gültige, aber verbrauchte App Check-Tokens enthält, werden Anfragen nicht automatisch abgelehnt. Stattdessen wird die Eigenschaft request.app.alreadyConsumed auf „true“ gesetzt und die Ausführung an den Handlercode übergeben, um weitere Entscheidungen zu treffen, z. B. das Erfordernis zusätzlicher Sicherheitsüberprüfungen oder das Ablehnen der Anfrage.

Unterschrift:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Bestimmt, ob Firebase AppCheck erzwungen wird.

Bei „true“ antworten Anfragen mit ungültigen Token automatisch mit dem Fehler 401 (nicht autorisiert). Bei „false“ setzen Anfragen mit ungültigen Token context.app auf „undefiend“.

Unterschrift:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Fehlerrichtlinie der Funktion, wobei der boolesche true der Bereitstellung eines leeren Wiederholungsobjekts entspricht.

Unterschrift:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Eingangseinstellungen, die steuern, von wo aus diese Funktion aufgerufen werden kann.

Unterschrift:

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

RuntimeOptions.invoker

Aufrufer zum Festlegen der Zugriffskontrolle für https-Funktionen.

Unterschrift:

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

RuntimeOptions.labels

Benutzerbezeichnungen, die für die Funktion festgelegt werden sollen.

Unterschrift:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

Maximale Anzahl tatsächlicher Instanzen, die parallel ausgeführt werden dürfen.

Unterschrift:

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

RuntimeOptions.memory

Speichermenge, die der Funktion zugewiesen werden soll.

Unterschrift:

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

RuntimeOptions.minInstances

Mindestanzahl tatsächlicher Instanzen, die zu einem bestimmten Zeitpunkt ausgeführt werden sollen.

Instanzen werden für die Speicherzuteilung und 10 % der CPU-Zuteilung im Leerlauf in Rechnung gestellt.

Unterschrift:

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

RuntimeOptions.preserveExternalChanges

Steuert, ob die außerhalb der Funktionsquelle geänderte Funktionskonfiguration erhalten bleibt. Der Standardwert ist „false“.

Wenn Sie eine in der zugrunde liegenden Plattform verfügbare Konfiguration festlegen, die im Firebase Functions SDK noch nicht verfügbar ist, empfehlen wir dringend, preserveExternalChanges auf true zu setzen . Andernfalls wird die manuell konfigurierte Einstellung Ihrer Funktion möglicherweise versehentlich gelöscht, wenn das Firebase Functions SDK eine neue Version des SDK mit Unterstützung für die fehlende Konfiguration veröffentlicht.

Unterschrift:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Unterschrift:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Spezifisches Dienstkonto, unter dem die Funktion ausgeführt werden soll.

Unterschrift:

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

RuntimeOptions.timeoutSeconds

Timeout für die Funktion in Sekunden, mögliche Werte sind 0 bis 540.

Unterschrift:

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

RuntimeOptions.vpcConnector

Cloud-Funktion mit dem angegebenen VPC-Connector verbinden.

Unterschrift:

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

RuntimeOptions.vpcConnectorEgressSettings

Ausgangseinstellungen für den VPC-Connector.

Unterschrift:

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

Konfigurationsoptionen für eine Funktion, die zur Laufzeit anwendbar sind.

Unterschrift:

export interface RuntimeOptions

Eigenschaften

Eigentum Typ Beschreibung
verbrauchenAppCheckToken Boolescher Wert Bestimmt, ob das Firebase App Check-Token auf Anfrage verbraucht wird. Der Standardwert ist „false“.
erzwingeAppCheck Boolescher Wert Bestimmt, ob Firebase AppCheck erzwungen wird.
Fehlerrichtlinie Fehlerrichtlinie | Boolescher Wert Fehlerrichtlinie der Funktion, wobei der boolesche true der Bereitstellung eines leeren Wiederholungsobjekts entspricht.
IngressSettings (Typ von INGRESS_SETTINGS_OPTIONS )[Anzahl] | Wert zurücksetzen Eingangseinstellungen, die steuern, von wo aus diese Funktion aufgerufen werden kann.
Anrufer „öffentlich“ | „privat“ | Zeichenfolge | string[] Aufrufer zum Festlegen der Zugriffskontrolle für https-Funktionen.
Etiketten Record<string, string> Benutzerbezeichnungen, die für die Funktion festgelegt werden sollen.
maxInstances Nummer | Ausdruck <Nummer> | Wert zurücksetzen Maximale Anzahl tatsächlicher Instanzen, die parallel ausgeführt werden dürfen.
Erinnerung (Typ von VALID_MEMORY_OPTIONS )[Anzahl] | Ausdruck <Nummer> | Wert zurücksetzen Speichermenge, die der Funktion zugewiesen werden soll.
minInstanzen Nummer | Ausdruck <Nummer> | Wert zurücksetzen Mindestanzahl tatsächlicher Instanzen, die zu einem bestimmten Zeitpunkt ausgeführt werden sollen.
PreserveExternalChanges Boolescher Wert Steuert, ob die außerhalb der Funktionsquelle geänderte Funktionskonfiguration erhalten bleibt. Der Standardwert ist „false“.
Geheimnisse (string | SecretParam)[]
serviceAccount „Standard“ | Zeichenfolge | Ausdruck <string> | Wert zurücksetzen Spezifisches Dienstkonto, unter dem die Funktion ausgeführt werden soll.
timeoutSekunden Nummer | Ausdruck <Nummer> | Wert zurücksetzen Timeout für die Funktion in Sekunden, mögliche Werte sind 0 bis 540.
vpcConnector Zeichenfolge | Ausdruck <string> | Wert zurücksetzen Cloud-Funktion mit dem angegebenen VPC-Connector verbinden.
vpcConnectorEgressSettings (Typ von VPC_EGRESS_SETTINGS_OPTIONS )[Anzahl] | Wert zurücksetzen Ausgangseinstellungen für den VPC-Connector.

RuntimeOptions.consumeAppCheckToken

Bestimmt, ob das Firebase App Check-Token auf Anfrage verbraucht wird. Der Standardwert ist „false“.

Legen Sie dies auf „true“ fest, um die App Check-Wiedergabeschutzfunktion zu aktivieren, indem das App Check-Token bei aufrufbarer Anfrage genutzt wird. Für Token, die bereits verbraucht sind, wird die Eigenschaft request.app.alreadyConsumed “ auf „true“ gesetzt.

Token gelten nur dann als verbraucht, wenn sie an den App Check-Dienst gesendet werden, indem diese Option auf „true“ gesetzt wird. Andere Verwendungen des Tokens verbrauchen ihn nicht.

Diese Wiedergabeschutzfunktion erfordert einen zusätzlichen Netzwerkaufruf an das App Check-Backend und zwingt die Clients, eine neue Bescheinigung von den ausgewählten Bescheinigungsanbietern zu erhalten. Dies kann sich daher negativ auf die Leistung auswirken und die Kontingente Ihrer Attestierungsanbieter möglicherweise schneller erschöpfen. Verwenden Sie diese Funktion nur zum Schutz von Vorgängen mit geringem Volumen, sicherheitskritischen oder teuren Vorgängen.

Diese Option hat keinen Einfluss auf die Option enforceAppCheck . Wenn Sie Letzteres auf „true“ setzen, antwortet die aufrufbare Funktion automatisch mit dem Statuscode „401 Unauthorized“, wenn die Anfrage ein ungültiges App Check-Token enthält. Wenn die Anfrage gültige, aber verbrauchte App Check-Tokens enthält, werden Anfragen nicht automatisch abgelehnt. Stattdessen wird die Eigenschaft request.app.alreadyConsumed auf „true“ gesetzt und die Ausführung an den Handlercode übergeben, um weitere Entscheidungen zu treffen, z. B. das Erfordernis zusätzlicher Sicherheitsüberprüfungen oder das Ablehnen der Anfrage.

Unterschrift:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Bestimmt, ob Firebase AppCheck erzwungen wird.

Bei „true“ antworten Anfragen mit ungültigen Token automatisch mit dem Fehler 401 (nicht autorisiert). Bei „false“ setzen Anfragen mit ungültigen Token context.app auf „undefiend“.

Unterschrift:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Fehlerrichtlinie der Funktion, wobei der boolesche true der Bereitstellung eines leeren Wiederholungsobjekts entspricht.

Unterschrift:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Eingangseinstellungen, die steuern, von wo aus diese Funktion aufgerufen werden kann.

Unterschrift:

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

RuntimeOptions.invoker

Aufrufer zum Festlegen der Zugriffskontrolle für https-Funktionen.

Unterschrift:

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

RuntimeOptions.labels

Benutzerbezeichnungen, die für die Funktion festgelegt werden sollen.

Unterschrift:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

Maximale Anzahl tatsächlicher Instanzen, die parallel ausgeführt werden dürfen.

Unterschrift:

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

RuntimeOptions.memory

Speichermenge, die der Funktion zugewiesen werden soll.

Unterschrift:

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

RuntimeOptions.minInstances

Mindestanzahl tatsächlicher Instanzen, die zu einem bestimmten Zeitpunkt ausgeführt werden sollen.

Instanzen werden für die Speicherzuteilung und 10 % der CPU-Zuteilung im Leerlauf in Rechnung gestellt.

Unterschrift:

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

RuntimeOptions.preserveExternalChanges

Steuert, ob die außerhalb der Funktionsquelle geänderte Funktionskonfiguration erhalten bleibt. Der Standardwert ist „false“.

Wenn Sie eine in der zugrunde liegenden Plattform verfügbare Konfiguration festlegen, die im Firebase Functions SDK noch nicht verfügbar ist, empfehlen wir dringend, preserveExternalChanges auf true zu setzen . Andernfalls wird die manuell konfigurierte Einstellung Ihrer Funktion möglicherweise versehentlich gelöscht, wenn das Firebase Functions SDK eine neue Version des SDK mit Unterstützung für die fehlende Konfiguration veröffentlicht.

Unterschrift:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Unterschrift:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Spezifisches Dienstkonto, unter dem die Funktion ausgeführt werden soll.

Unterschrift:

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

RuntimeOptions.timeoutSeconds

Timeout für die Funktion in Sekunden, mögliche Werte sind 0 bis 540.

Unterschrift:

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

RuntimeOptions.vpcConnector

Cloud-Funktion mit dem angegebenen VPC-Connector verbinden.

Unterschrift:

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

RuntimeOptions.vpcConnectorEgressSettings

Ausgangseinstellungen für den VPC-Connector.

Unterschrift:

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