CosmosDBv4FunctionOptions interface

Pacchetto:

@azure/functions

Extends

CosmosDBv4TriggerOptions,Partial<FunctionOptions>

Proprietà

handler
retry	Un criterio di ripetizione dei tentativi facoltativo per rieseguire un'esecuzione non riuscita fino a quando non si verifica il completamento o viene raggiunto il numero massimo di tentativi. Altre qui
trigger

Proprietà ereditate

connection	Un'impostazione dell'app (o variabile di ambiente) con la stringa di connessione di Cosmos DB
containerName	Nome del contenitore monitorato
createLeaseContainerIfNotExists	Verifica l'esistenza e crea automaticamente il contenitore di lease. Il valore predefinito è false
databaseName	Nome del database Azure Cosmos DB con il contenitore monitorato
extraInputs	Configurazione per un set facoltativo di input secondari durante la chiamata, ottenere questi valori con context.extraInputs.get()
extraOutputs	Configurazione per un set facoltativo di output secondari durante la chiamata, impostare questi valori con context.extraOutputs.set()
feedPollDelay	Tempo (in millisecondi) per il ritardo tra il polling di una partizione per le nuove modifiche nel feed, dopo che tutte le modifiche correnti vengono svuotate. Il valore predefinito è 5.000 millisecondi o 5 secondi.
leaseAcquireInterval	Quando impostato, definisce, in millisecondi, l'intervallo per avviare un'attività da calcolare se le partizioni vengono distribuite uniformemente tra le istanze host note. Il valore predefinito è 13000 (13 secondi).
leaseConnection	Nome di un'impostazione dell'app che contiene la stringa di connessione al servizio che contiene il contenitore di lease. Se non impostato, si connetterà al servizio definito da connection
leaseContainerName	Nome del contenitore in cui archiviare i lease. Se non è impostato, userà "lease"
leaseContainerPrefix	Se impostato, il valore viene aggiunto come prefisso ai lease creati nel contenitore Lease per questa funzione. L'uso di un prefisso consente a due funzioni di Azure separate di condividere lo stesso contenitore lease usando prefissi diversi.
leaseDatabaseName	Nome del database che contiene il contenitore per archiviare i lease. Se non impostato, userà il valore di databaseName
leaseExpirationInterval	Quando impostato, definisce, in millisecondi, l'intervallo per il quale il lease viene assunto in un lease che rappresenta una partizione. Se il lease non viene rinnovato entro questo intervallo, lo scadrà e la proprietà della partizione verrà spostata in un'altra istanza. Il valore predefinito è 60000 (60 secondi).
leaseRenewInterval	Se impostato, definisce, in millisecondi, l'intervallo di rinnovo per tutti i lease per le partizioni attualmente contenute in un'istanza di . Il valore predefinito è 17000 (17 secondi).
leasesContainerThroughput	Quando createLeaseContainerIfNotExists è impostato su true, definisce la quantità di unità richiesta da assegnare al contenitore di lease creato
maxItemsPerInvocation	Se impostata, questa proprietà imposta il numero massimo di elementi ricevuti per ogni chiamata di Funzione. Se le operazioni nel contenitore monitorato vengono eseguite tramite stored procedure, l'ambito della transazione viene mantenuto durante la lettura degli elementi dal feed di modifiche. Di conseguenza, il numero di elementi ricevuti potrebbe essere superiore al valore specificato in modo che gli elementi modificati dalla stessa transazione vengano restituiti come parte di un batch atomico.
preferredLocations	Definisce le posizioni preferite (aree) per gli account di database con replica geografica nel servizio Azure Cosmos DB. I valori devono essere delimitati da virgole. Ad esempio, Stati Uniti orientali, Stati Uniti centro-meridionali, Europa settentrionale
return	Configurazione per l'output primario facoltativo della funzione Questo è l'output principale che è necessario impostare come valore restituito del gestore di funzioni durante la chiamata
startFromBeginning	Questa opzione indica al trigger di leggere le modifiche dall'inizio della cronologia delle modifiche del contenitore anziché a partire dall'ora corrente. La lettura dall'inizio funziona solo la prima volta che il trigger viene avviato, come nelle esecuzioni successive, i checkpoint sono già archiviati. L'impostazione di questa opzione su true quando sono già stati creati lease non ha alcun effetto.
startFromTime	Ottiene o imposta la data e l'ora da cui inizializzare l'operazione di lettura del feed di modifiche. Il formato consigliato è ISO 8601 con l'identificatore UTC, ad esempio 2021-02-16T14:19:29Z. Viene usato solo per impostare lo stato del trigger iniziale. Dopo che il trigger ha uno stato di lease, la modifica di questo valore non ha alcun effetto.

Dettagli proprietà

handler

handler: CosmosDBv4Handler

Valore della proprietà

CosmosDBv4Handler

retry

Un criterio di ripetizione dei tentativi facoltativo per rieseguire un'esecuzione non riuscita fino a quando non si verifica il completamento o viene raggiunto il numero massimo di tentativi. Altre qui

retry?: RetryOptions

Valore della proprietà

RetryOptions

trigger

trigger?: CosmosDBv4Trigger

Valore della proprietà

CosmosDBv4Trigger

Dettagli proprietà ereditate

connection

Un'impostazione dell'app (o variabile di ambiente) con la stringa di connessione di Cosmos DB

connection: string

Valore della proprietà

string

ereditato daCosmosDBv4TriggerOptions.connection

containerName

Nome del contenitore monitorato

containerName: string

Valore della proprietà

string

Ereditato daCosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

Verifica l'esistenza e crea automaticamente il contenitore di lease. Il valore predefinito è false

createLeaseContainerIfNotExists?: boolean

Valore della proprietà

boolean

Ereditato daCosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

Nome del database Azure Cosmos DB con il contenitore monitorato

databaseName: string

Valore della proprietà

string

ereditato daCosmosDBv4TriggerOptions.databaseName

extraInputs

Configurazione per un set facoltativo di input secondari durante la chiamata, ottenere questi valori con context.extraInputs.get()

extraInputs?: FunctionInput[]

Valore della proprietà

FunctionInput[]

Ereditato da Partial.extraInputs

extraOutputs

Configurazione per un set facoltativo di output secondari durante la chiamata, impostare questi valori con context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Valore della proprietà

FunctionOutput[]

Ereditato da Partial.extraOutputs

feedPollDelay

Tempo (in millisecondi) per il ritardo tra il polling di una partizione per le nuove modifiche nel feed, dopo che tutte le modifiche correnti vengono svuotate. Il valore predefinito è 5.000 millisecondi o 5 secondi.

feedPollDelay?: number

Valore della proprietà

number

Ereditato daCosmosDBv4TriggerOptions.feedPollDelay

leaseAcquireInterval

Quando impostato, definisce, in millisecondi, l'intervallo per avviare un'attività da calcolare se le partizioni vengono distribuite uniformemente tra le istanze host note. Il valore predefinito è 13000 (13 secondi).

leaseAcquireInterval?: number

Valore della proprietà

number

ereditato daCosmosDBv4TriggerOptions.leaseAcquireInterval

leaseConnection

Nome di un'impostazione dell'app che contiene la stringa di connessione al servizio che contiene il contenitore di lease. Se non impostato, si connetterà al servizio definito da connection

leaseConnection?: string

Valore della proprietà

string

ereditato daCosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

Nome del contenitore in cui archiviare i lease. Se non è impostato, userà "lease"

leaseContainerName?: string

Valore della proprietà

string

Ereditato daCosmosDBv4TriggerOptions.leaseContainerName

leaseContainerPrefix

Se impostato, il valore viene aggiunto come prefisso ai lease creati nel contenitore Lease per questa funzione. L'uso di un prefisso consente a due funzioni di Azure separate di condividere lo stesso contenitore lease usando prefissi diversi.

leaseContainerPrefix?: string

Valore della proprietà

string

Ereditato daCosmosDBv4TriggerOptions.leaseContainerPrefix

leaseDatabaseName

Nome del database che contiene il contenitore per archiviare i lease. Se non impostato, userà il valore di databaseName

leaseDatabaseName?: string

Valore della proprietà

string

Ereditato daCosmosDBv4TriggerOptions.leaseDatabaseName

leaseExpirationInterval

Quando impostato, definisce, in millisecondi, l'intervallo per il quale il lease viene assunto in un lease che rappresenta una partizione. Se il lease non viene rinnovato entro questo intervallo, lo scadrà e la proprietà della partizione verrà spostata in un'altra istanza. Il valore predefinito è 60000 (60 secondi).

leaseExpirationInterval?: number

Valore della proprietà

number

ereditato daCosmosDBv4TriggerOptions.leaseExpirationInterval

leaseRenewInterval

Se impostato, definisce, in millisecondi, l'intervallo di rinnovo per tutti i lease per le partizioni attualmente contenute in un'istanza di . Il valore predefinito è 17000 (17 secondi).

leaseRenewInterval?: number

Valore della proprietà

number

Ereditato daCosmosDBv4TriggerOptions.leaseRenewInterval

leasesContainerThroughput

Quando createLeaseContainerIfNotExists è impostato su true, definisce la quantità di unità richiesta da assegnare al contenitore di lease creato

leasesContainerThroughput?: number

Valore della proprietà

number

Ereditato daCosmosDBv4TriggerOptions.leasesContainerThroughput

maxItemsPerInvocation

Se impostata, questa proprietà imposta il numero massimo di elementi ricevuti per ogni chiamata di Funzione. Se le operazioni nel contenitore monitorato vengono eseguite tramite stored procedure, l'ambito della transazione viene mantenuto durante la lettura degli elementi dal feed di modifiche. Di conseguenza, il numero di elementi ricevuti potrebbe essere superiore al valore specificato in modo che gli elementi modificati dalla stessa transazione vengano restituiti come parte di un batch atomico.

maxItemsPerInvocation?: number

Valore della proprietà

number

Ereditato daCosmosDBv4TriggerOptions.maxItemsPerInvocation

preferredLocations

Definisce le posizioni preferite (aree) per gli account di database con replica geografica nel servizio Azure Cosmos DB. I valori devono essere delimitati da virgole. Ad esempio, Stati Uniti orientali, Stati Uniti centro-meridionali, Europa settentrionale

preferredLocations?: string

Valore della proprietà

string

Ereditato daCosmosDBv4TriggerOptions.preferredLocations

return

Configurazione per l'output primario facoltativo della funzione Questo è l'output principale che è necessario impostare come valore restituito del gestore di funzioni durante la chiamata

return?: FunctionOutput

Valore della proprietà

FunctionOutput

Ereditato da Partial.return

startFromBeginning

Questa opzione indica al trigger di leggere le modifiche dall'inizio della cronologia delle modifiche del contenitore anziché a partire dall'ora corrente. La lettura dall'inizio funziona solo la prima volta che il trigger viene avviato, come nelle esecuzioni successive, i checkpoint sono già archiviati. L'impostazione di questa opzione su true quando sono già stati creati lease non ha alcun effetto.

startFromBeginning?: boolean

Valore della proprietà

boolean

Ereditato daCosmosDBv4TriggerOptions.startFromBeginning

startFromTime

Ottiene o imposta la data e l'ora da cui inizializzare l'operazione di lettura del feed di modifiche. Il formato consigliato è ISO 8601 con l'identificatore UTC, ad esempio 2021-02-16T14:19:29Z. Viene usato solo per impostare lo stato del trigger iniziale. Dopo che il trigger ha uno stato di lease, la modifica di questo valore non ha alcun effetto.

startFromTime?: string

Valore della proprietà

string

Ereditato daCosmosDBv4TriggerOptions.startFromTime