RuntimeOptions interface

Opzioni di configurazione per una funzione applicabile in fase di esecuzione.

Firma:

export interface RuntimeOptions

Proprietà

Proprietà Tipo Descrizione
consumareAppCheckToken booleano Determina se il token Firebase App Check viene utilizzato su richiesta. Il valore predefinito è falso.
imporreAppCheck booleano Determina se Firebase AppCheck viene applicato.
fallimentoPolitica Politica di fallimento | booleano Politica di errore della funzione, dove boolean true equivale a fornire un oggetto nuovo tentativo vuoto.
inputSettings (tipo di INGRESS_SETTINGS_OPTIONS )[numero] | ResetValore Impostazioni di ingresso che controllano da dove può essere chiamata questa funzione.
invocatore "pubblico" | "privato" | stringa | corda[] Invoker per impostare il controllo degli accessi sulle funzioni https.
etichette Registra<stringa, stringa> Etichette utente da impostare sulla funzione.
maxInstances numero | Espressione <numero> | ResetValore Numero massimo di istanze effettive che possono essere eseguite in parallelo.
memoria (tipo di VALID_MEMORY_OPTIONS )[numero] | Espressione <numero> | ResetValore Quantità di memoria da allocare alla funzione.
minInstances numero | Espressione <numero> | ResetValore Numero minimo di istanze effettive da eseguire in un determinato momento.
preservareExternalChanges booleano Controlla se la configurazione della funzione modificata all'esterno dell'origine della funzione viene mantenuta. Il valore predefinito è falso.
segreti (string | SecretParam)[]
serviceAccount "predefinito" | stringa | Espressione <stringa> | ResetValore Account di servizio specifico per l'esecuzione della funzione.
timeoutSecondi numero | Espressione <numero> | ResetValore Timeout per la funzione in secondi, i valori possibili sono compresi tra 0 e 540.
vpcConnettore stringa | Espressione <stringa> | ResetValore Connetti la funzione cloud al connettore VPC specificato.
vpcConnectorEgressSettings (tipo di VPC_EGRESS_SETTINGS_OPTIONS )[numero] | ResetValore Impostazioni di uscita per il connettore VPC.

RuntimeOptions.consumeAppCheckToken

Determina se il token Firebase App Check viene utilizzato su richiesta. Il valore predefinito è falso.

Impostalo su true per abilitare la funzionalità di protezione dalla riproduzione di App Check consumando il token App Check su richiesta richiamabile. I token che risultano già utilizzati avranno la proprietà request.app.alreadyConsumed impostata su true.

I token vengono considerati consumati solo se vengono inviati al servizio App Check impostando questa opzione su true. Altri usi del token non lo consumano.

Questa funzionalità di protezione dalla riproduzione richiede una chiamata di rete aggiuntiva al backend App Check e obbliga i client a ottenere una nuova attestazione dai fornitori di attestazioni scelti. Ciò può quindi avere un impatto negativo sulle prestazioni e potenzialmente esaurire più rapidamente le quote dei provider di attestazioni. Utilizzare questa funzionalità solo per proteggere operazioni a basso volume, critiche per la sicurezza o costose.

Questa opzione non influisce sull'opzione enforceAppCheck . Impostando quest'ultimo su true, la funzione richiamabile risponderà automaticamente con un codice di stato 401 Non autorizzato quando la richiesta include un token App Check non valido. Quando la richiesta include token App Check validi ma consumati, le richieste non verranno rifiutate automaticamente. Invece, la proprietà request.app.alreadyConsumed verrà impostata su true e passerà l'esecuzione al codice del gestore per prendere ulteriori decisioni, come richiedere ulteriori controlli di sicurezza o rifiutare la richiesta.

Firma:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Determina se Firebase AppCheck viene applicato.

Quando è vero, le richieste con token non validi rispondono automaticamente con un errore 401 (Non autorizzato). Se false, le richieste con token non validi impostano context.app su undefiend.

Firma:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Politica di errore della funzione, dove boolean true equivale a fornire un oggetto nuovo tentativo vuoto.

Firma:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Impostazioni di ingresso che controllano da dove può essere chiamata questa funzione.

Firma:

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

RuntimeOptions.invoker

Invoker per impostare il controllo degli accessi sulle funzioni https.

Firma:

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

RuntimeOptions.labels

Etichette utente da impostare sulla funzione.

Firma:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

Numero massimo di istanze effettive che possono essere eseguite in parallelo.

Firma:

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

RuntimeOptions.memory

Quantità di memoria da allocare alla funzione.

Firma:

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

RuntimeOptions.minInstances

Numero minimo di istanze effettive da eseguire in un determinato momento.

Alle istanze verrà addebitata l'allocazione della memoria e il 10% dell'allocazione della CPU mentre sono inattive.

Firma:

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

RuntimeOptions.preserveExternalChanges

Controlla se la configurazione della funzione modificata all'esterno dell'origine della funzione viene mantenuta. Il valore predefinito è falso.

Quando imposti la configurazione disponibile nella piattaforma sottostante che non è ancora disponibile nell'SDK di Firebase Functions, ti consigliamo vivamente di impostare preserveExternalChanges su true . In caso contrario, quando l'SDK di Firebase Functions rilascia una nuova versione dell'SDK con il supporto per la configurazione mancante, l'impostazione configurata manualmente della funzione potrebbe essere inavvertitamente cancellata.

Firma:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Firma:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Account di servizio specifico per l'esecuzione della funzione.

Firma:

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

RuntimeOptions.timeoutSeconds

Timeout per la funzione in secondi, i valori possibili sono compresi tra 0 e 540.

Firma:

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

RuntimeOptions.vpcConnector

Connetti la funzione cloud al connettore VPC specificato.

Firma:

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

RuntimeOptions.vpcConnectorEgressSettings

Impostazioni di uscita per il connettore VPC.

Firma:

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

Opzioni di configurazione per una funzione applicabile in fase di esecuzione.

Firma:

export interface RuntimeOptions

Proprietà

Proprietà Tipo Descrizione
consumareAppCheckToken booleano Determina se il token Firebase App Check viene utilizzato su richiesta. Il valore predefinito è falso.
imporreAppCheck booleano Determina se Firebase AppCheck viene applicato.
fallimentoPolitica Politica di fallimento | booleano Politica di errore della funzione, dove boolean true equivale a fornire un oggetto nuovo tentativo vuoto.
inputSettings (tipo di INGRESS_SETTINGS_OPTIONS )[numero] | ResetValore Impostazioni di ingresso che controllano da dove può essere chiamata questa funzione.
invocatore "pubblico" | "privato" | stringa | corda[] Invoker per impostare il controllo degli accessi sulle funzioni https.
etichette Registra<stringa, stringa> Etichette utente da impostare sulla funzione.
maxInstances numero | Espressione <numero> | ResetValore Numero massimo di istanze effettive che possono essere eseguite in parallelo.
memoria (tipo di VALID_MEMORY_OPTIONS )[numero] | Espressione <numero> | ResetValore Quantità di memoria da allocare alla funzione.
minInstances numero | Espressione <numero> | ResetValore Numero minimo di istanze effettive da eseguire in un determinato momento.
preservareExternalChanges booleano Controlla se la configurazione della funzione modificata all'esterno dell'origine della funzione viene mantenuta. Il valore predefinito è falso.
segreti (string | SecretParam)[]
serviceAccount "predefinito" | stringa | Espressione <stringa> | ResetValore Account di servizio specifico per l'esecuzione della funzione.
timeoutSecondi numero | Espressione <numero> | ResetValore Timeout per la funzione in secondi, i valori possibili sono compresi tra 0 e 540.
vpcConnettore stringa | Espressione <stringa> | ResetValore Connetti la funzione cloud al connettore VPC specificato.
vpcConnectorEgressSettings (tipo di VPC_EGRESS_SETTINGS_OPTIONS )[numero] | ResetValore Impostazioni di uscita per il connettore VPC.

RuntimeOptions.consumeAppCheckToken

Determina se il token Firebase App Check viene utilizzato su richiesta. Il valore predefinito è falso.

Impostalo su true per abilitare la funzionalità di protezione dalla riproduzione di App Check consumando il token App Check su richiesta richiamabile. I token che risultano già utilizzati avranno la proprietà request.app.alreadyConsumed impostata su true.

I token vengono considerati consumati solo se vengono inviati al servizio App Check impostando questa opzione su true. Altri usi del token non lo consumano.

Questa funzionalità di protezione dalla riproduzione richiede una chiamata di rete aggiuntiva al backend App Check e obbliga i client a ottenere una nuova attestazione dai fornitori di attestazioni scelti. Ciò può quindi avere un impatto negativo sulle prestazioni e potenzialmente esaurire più rapidamente le quote dei provider di attestazioni. Utilizzare questa funzionalità solo per proteggere operazioni a basso volume, critiche per la sicurezza o costose.

Questa opzione non influisce sull'opzione enforceAppCheck . Impostando quest'ultimo su true, la funzione richiamabile risponderà automaticamente con un codice di stato 401 Non autorizzato quando la richiesta include un token App Check non valido. Quando la richiesta include token App Check validi ma consumati, le richieste non verranno rifiutate automaticamente. Invece, la proprietà request.app.alreadyConsumed verrà impostata su true e passerà l'esecuzione al codice del gestore per prendere ulteriori decisioni, come richiedere ulteriori controlli di sicurezza o rifiutare la richiesta.

Firma:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Determina se Firebase AppCheck viene applicato.

Quando è vero, le richieste con token non validi rispondono automaticamente con un errore 401 (Non autorizzato). Se false, le richieste con token non validi impostano context.app su undefiend.

Firma:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Politica di errore della funzione, dove boolean true equivale a fornire un oggetto nuovo tentativo vuoto.

Firma:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Impostazioni di ingresso che controllano da dove può essere chiamata questa funzione.

Firma:

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

RuntimeOptions.invoker

Invoker per impostare il controllo degli accessi sulle funzioni https.

Firma:

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

RuntimeOptions.labels

Etichette utente da impostare sulla funzione.

Firma:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

Numero massimo di istanze effettive che possono essere eseguite in parallelo.

Firma:

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

RuntimeOptions.memory

Quantità di memoria da allocare alla funzione.

Firma:

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

RuntimeOptions.minInstances

Numero minimo di istanze effettive da eseguire in un determinato momento.

Alle istanze verrà addebitata l'allocazione della memoria e il 10% dell'allocazione della CPU mentre sono inattive.

Firma:

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

RuntimeOptions.preserveExternalChanges

Controlla se la configurazione della funzione modificata all'esterno dell'origine della funzione viene mantenuta. Il valore predefinito è falso.

Quando imposti la configurazione disponibile nella piattaforma sottostante che non è ancora disponibile nell'SDK di Firebase Functions, ti consigliamo vivamente di impostare preserveExternalChanges su true . In caso contrario, quando l'SDK di Firebase Functions rilascia una nuova versione dell'SDK con il supporto per la configurazione mancante, l'impostazione configurata manualmente della funzione potrebbe essere inavvertitamente cancellata.

Firma:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Firma:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Account di servizio specifico per l'esecuzione della funzione.

Firma:

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

RuntimeOptions.timeoutSeconds

Timeout per la funzione in secondi, i valori possibili sono compresi tra 0 e 540.

Firma:

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

RuntimeOptions.vpcConnector

Connetti la funzione cloud al connettore VPC specificato.

Firma:

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

RuntimeOptions.vpcConnectorEgressSettings

Impostazioni di uscita per il connettore VPC.

Firma:

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