CosmosDBv3FunctionOptions interface

Pacchetto:

@azure/functions

Extends

CosmosDBv3TriggerOptions,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

checkpointDocumentCount	Personalizza la quantità di documenti tra checkpoint di lease. Il valore predefinito è dopo ogni chiamata di funzione.
checkpointInterval	Se impostato, definisce, in millisecondi, l'intervallo tra i checkpoint di lease. Il valore predefinito è sempre dopo ogni chiamata di Funzione.
collectionName	Nome della raccolta monitorata
connectionStringSetting	Un'impostazione dell'app (o variabile di ambiente) con la stringa di connessione di Cosmos DB
createLeaseCollectionIfNotExists	Verifica l'esistenza e crea automaticamente la raccolta di lease. Il valore predefinito è false
databaseName	Nome del database Azure Cosmos DB con la raccolta monitorata
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).
leaseCollectionName	Nome della raccolta in cui archiviare i lease. Se non è impostato, userà "lease"
leaseCollectionPrefix	Se impostato, il valore viene aggiunto come prefisso ai lease creati nella raccolta Lease per questa funzione. L'uso di un prefisso consente a due funzioni di Azure separate di condividere la stessa raccolta lease usando prefissi diversi.
leaseCollectionThroughput	Quando createLeaseCollectionIfNotExists è impostato su true, definisce la quantità di unità richiesta da assegnare alla raccolta di lease creata
leaseConnectionStringSetting	Nome di un'impostazione dell'app che contiene la stringa di connessione al servizio che contiene la raccolta di lease. Se non impostato, si connetterà al servizio definito da connectionStringSetting
leaseDatabaseName	Nome del database che contiene la raccolta in cui 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).
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.
useMultipleWriteLocations	Abilita gli account in più aree per la scrittura nella raccolta di lease.

Dettagli proprietà

handler

handler: CosmosDBv3Handler

Valore della proprietà

CosmosDBv3Handler

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?: CosmosDBv3Trigger

Valore della proprietà

CosmosDBv3Trigger

Dettagli proprietà ereditate

checkpointDocumentCount

Personalizza la quantità di documenti tra checkpoint di lease. Il valore predefinito è dopo ogni chiamata di funzione.

checkpointDocumentCount?: number

Valore della proprietà

number

Ereditato daCosmosDBv3TriggerOptions.checkpointDocumentCount

checkpointInterval

Se impostato, definisce, in millisecondi, l'intervallo tra i checkpoint di lease. Il valore predefinito è sempre dopo ogni chiamata di Funzione.

checkpointInterval?: number

Valore della proprietà

number

Ereditato daCosmosDBv3TriggerOptions.checkpointInterval

collectionName

Nome della raccolta monitorata

collectionName: string

Valore della proprietà

string

ereditato daCosmosDBv3TriggerOptions.collectionName

connectionStringSetting

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

connectionStringSetting: string

Valore della proprietà

string

Ereditato daCosmosDBv3TriggerOptions.connectionStringSetting

createLeaseCollectionIfNotExists

Verifica l'esistenza e crea automaticamente la raccolta di lease. Il valore predefinito è false

createLeaseCollectionIfNotExists?: boolean

Valore della proprietà

boolean

Ereditato daCosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

databaseName

Nome del database Azure Cosmos DB con la raccolta monitorata

databaseName: string

Valore della proprietà

string

ereditato daCosmosDBv3TriggerOptions.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 daCosmosDBv3TriggerOptions.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 daCosmosDBv3TriggerOptions.leaseAcquireInterval

leaseCollectionName

Nome della raccolta in cui archiviare i lease. Se non è impostato, userà "lease"

leaseCollectionName?: string

Valore della proprietà

string

Ereditato daCosmosDBv3TriggerOptions.leaseCollectionName

leaseCollectionPrefix

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

leaseCollectionPrefix?: string

Valore della proprietà

string

Ereditato daCosmosDBv3TriggerOptions.leaseCollectionPrefix

leaseCollectionThroughput

Quando createLeaseCollectionIfNotExists è impostato su true, definisce la quantità di unità richiesta da assegnare alla raccolta di lease creata

leaseCollectionThroughput?: number

Valore della proprietà

number

Ereditato daCosmosDBv3TriggerOptions.leaseCollectionThroughput

leaseConnectionStringSetting

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

leaseConnectionStringSetting?: string

Valore della proprietà

string

Ereditato daCosmosDBv3TriggerOptions.leaseConnectionStringSetting

leaseDatabaseName

Nome del database che contiene la raccolta in cui archiviare i lease. Se non impostato, userà il valore di databaseName

leaseDatabaseName?: string

Valore della proprietà

string

Ereditato daCosmosDBv3TriggerOptions.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 daCosmosDBv3TriggerOptions.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 daCosmosDBv3TriggerOptions.leaseRenewInterval

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 daCosmosDBv3TriggerOptions.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 daCosmosDBv3TriggerOptions.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 daCosmosDBv3TriggerOptions.startFromBeginning

useMultipleWriteLocations

Abilita gli account in più aree per la scrittura nella raccolta di lease.

useMultipleWriteLocations?: boolean

Valore della proprietà

boolean

Ereditato daCosmosDBv3TriggerOptions.useMultipleWriteLocations