CosmosDBv3FunctionOptions interface

Paket:

@azure/functions

Extends

CosmosDBv3TriggerOptions,Partial<FunctionOptions>

Egenskaper

handler
retry	En valfri återförsöksprincip för att köra en misslyckad körning igen tills antingen slutförandet har slutförts eller det maximala antalet återförsök har uppnåtts. Läs mer här
trigger

Ärvda egenskaper

checkpointDocumentCount	Anpassar mängden dokument mellan lånekontrollpunkter. Standardvärdet är efter varje funktionsanrop.
checkpointInterval	När den anges definierar den i millisekunder intervallet mellan lånekontrollpunkter. Standardvärdet är alltid efter varje funktionsanrop.
collectionName	Namnet på samlingen som övervakas
connectionStringSetting	En appinställning (eller miljövariabel) med Cosmos DB-anslutningssträngen
createLeaseCollectionIfNotExists	Söker efter existens och skapar automatiskt lånesamlingen. Standardvärdet är false
databaseName	Namnet på Azure Cosmos DB-databasen med samlingen som övervakas
extraInputs	Konfiguration för en valfri uppsättning sekundära indata Under anrop hämtar du dessa värden med context.extraInputs.get()
extraOutputs	Konfiguration för en valfri uppsättning sekundära utdata Under anrop anger du dessa värden med context.extraOutputs.set()
feedPollDelay	Tiden (i millisekunder) för fördröjningen mellan avsökningen av en partition för nya ändringar i flödet, när alla aktuella ändringar har tömts. Standardvärdet är 5 000 millisekunder eller 5 sekunder.
leaseAcquireInterval	När den anges definierar den i millisekunder intervallet för att starta en uppgift för att beräkna om partitioner fördelas jämnt mellan kända värdinstanser. Standardvärdet är 13 000 (13 sekunder).
leaseCollectionName	Namnet på samlingen som ska lagra lån. Om den inte har angetts använder den "lån"
leaseCollectionPrefix	När värdet anges läggs det till som ett prefix till lånen som skapats i lånesamlingen för den här funktionen. Med hjälp av ett prefix kan två separata Azure Functions dela samma lånesamling med hjälp av olika prefix.
leaseCollectionThroughput	När createLeaseCollectionIfNotExists är inställt på truedefinierar mängden enheter för begäranden som ska tilldelas till den skapade lånesamlingen
leaseConnectionStringSetting	Namnet på en appinställning som innehåller anslutningssträngen till tjänsten som innehåller lånesamlingen. Om den inte anges ansluter den till den tjänst som definierats av connectionStringSetting
leaseDatabaseName	Namnet på databasen som innehåller samlingen för att lagra lån. Om den inte anges använder den värdet för databaseName
leaseExpirationInterval	När den anges definierar den i millisekunder det intervall för vilket lånet tas på ett lån som representerar en partition. Om lånet inte förnyas inom det här intervallet upphör det att gälla och ägarskapet för partitionen flyttas till en annan instans. Standardvärdet är 60000 (60 sekunder).
leaseRenewInterval	När den anges definierar den, i millisekunder, förnyelseintervallet för alla lån för partitioner som för närvarande innehas av en instans. Standardvärdet är 17 000 (17 sekunder).
maxItemsPerInvocation	När den här egenskapen anges anger den maximala antalet objekt som tas emot per funktionsanrop. Om åtgärder i den övervakade containern utförs via lagrade procedurer bevaras transaktionsomfånget vid läsning av objekt från ändringsflödet. Därför kan antalet mottagna objekt vara högre än det angivna värdet så att objekten som ändras av samma transaktion returneras som en del av en atomisk batch.
preferredLocations	Definierar önskade platser (regioner) för geo-replikerade databaskonton i Azure Cosmos DB-tjänsten. Värden bör kommaavgränsas. Till exempel USA, östra, USA, södra centrala, Europa, norra
return	Konfiguration för valfria primära utdata för funktionen Det här är de viktigaste utdata som du bör ange som returvärde för funktionshanteraren under anropet
startFromBeginning	Det här alternativet instruerar utlösaren att läsa ändringar från början av containerns ändringshistorik i stället för att starta vid den aktuella tidpunkten. Läsning från början fungerar bara första gången utlösaren startar, eftersom kontrollpunkterna redan lagras i efterföljande körningar. Att ange det här alternativet till sant när det redan har skapats lån har ingen effekt.
useMultipleWriteLocations	Aktiverar konton i flera regioner för att skriva till lånesamlingen.

Egenskapsinformation

handler

handler: CosmosDBv3Handler

Egenskapsvärde

CosmosDBv3Handler

retry

En valfri återförsöksprincip för att köra en misslyckad körning igen tills antingen slutförandet har slutförts eller det maximala antalet återförsök har uppnåtts. Läs mer här

retry?: RetryOptions

Egenskapsvärde

RetryOptions

trigger

trigger?: CosmosDBv3Trigger

Egenskapsvärde

CosmosDBv3Trigger

Information om ärvda egenskaper

checkpointDocumentCount

Anpassar mängden dokument mellan lånekontrollpunkter. Standardvärdet är efter varje funktionsanrop.

checkpointDocumentCount?: number

Egenskapsvärde

number

ärvd frånCosmosDBv3TriggerOptions.checkpointDocumentCount

checkpointInterval

När den anges definierar den i millisekunder intervallet mellan lånekontrollpunkter. Standardvärdet är alltid efter varje funktionsanrop.

checkpointInterval?: number

Egenskapsvärde

number

ärvs frånCosmosDBv3TriggerOptions.checkpointInterval

collectionName

Namnet på samlingen som övervakas

collectionName: string

Egenskapsvärde

string

ärvs frånCosmosDBv3TriggerOptions.collectionName

connectionStringSetting

En appinställning (eller miljövariabel) med Cosmos DB-anslutningssträngen

connectionStringSetting: string

Egenskapsvärde

string

ärvd frånCosmosDBv3TriggerOptions.connectionStringSetting

createLeaseCollectionIfNotExists

Söker efter existens och skapar automatiskt lånesamlingen. Standardvärdet är false

createLeaseCollectionIfNotExists?: boolean

Egenskapsvärde

boolean

ärvd frånCosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

databaseName

Namnet på Azure Cosmos DB-databasen med samlingen som övervakas

databaseName: string

Egenskapsvärde

string

ärvd frånCosmosDBv3TriggerOptions.databaseName

extraInputs

Konfiguration för en valfri uppsättning sekundära indata Under anrop hämtar du dessa värden med context.extraInputs.get()

extraInputs?: FunctionInput[]

Egenskapsvärde

FunctionInput[]

ärvs från Partial.extraInputs

extraOutputs

Konfiguration för en valfri uppsättning sekundära utdata Under anrop anger du dessa värden med context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Egenskapsvärde

FunctionOutput[]

ärvs från Partial.extraOutputs

feedPollDelay

Tiden (i millisekunder) för fördröjningen mellan avsökningen av en partition för nya ändringar i flödet, när alla aktuella ändringar har tömts. Standardvärdet är 5 000 millisekunder eller 5 sekunder.

feedPollDelay?: number

Egenskapsvärde

number

ärvd frånCosmosDBv3TriggerOptions.feedPollDelay

leaseAcquireInterval

När den anges definierar den i millisekunder intervallet för att starta en uppgift för att beräkna om partitioner fördelas jämnt mellan kända värdinstanser. Standardvärdet är 13 000 (13 sekunder).

leaseAcquireInterval?: number

Egenskapsvärde

number

ärvd frånCosmosDBv3TriggerOptions.leaseAcquireInterval

leaseCollectionName

Namnet på samlingen som ska lagra lån. Om den inte har angetts använder den "lån"

leaseCollectionName?: string

Egenskapsvärde

string

ärvd frånCosmosDBv3TriggerOptions.leaseCollectionName

leaseCollectionPrefix

När värdet anges läggs det till som ett prefix till lånen som skapats i lånesamlingen för den här funktionen. Med hjälp av ett prefix kan två separata Azure Functions dela samma lånesamling med hjälp av olika prefix.

leaseCollectionPrefix?: string

Egenskapsvärde

string

ärvd frånCosmosDBv3TriggerOptions.leaseCollectionPrefix

leaseCollectionThroughput

När createLeaseCollectionIfNotExists är inställt på truedefinierar mängden enheter för begäranden som ska tilldelas till den skapade lånesamlingen

leaseCollectionThroughput?: number

Egenskapsvärde

number

ärvd frånCosmosDBv3TriggerOptions.leaseCollectionThroughput

leaseConnectionStringSetting

Namnet på en appinställning som innehåller anslutningssträngen till tjänsten som innehåller lånesamlingen. Om den inte anges ansluter den till den tjänst som definierats av connectionStringSetting

leaseConnectionStringSetting?: string

Egenskapsvärde

string

ärvd frånCosmosDBv3TriggerOptions.leaseConnectionStringSetting

leaseDatabaseName

Namnet på databasen som innehåller samlingen för att lagra lån. Om den inte anges använder den värdet för databaseName

leaseDatabaseName?: string

Egenskapsvärde

string

ärvd frånCosmosDBv3TriggerOptions.leaseDatabaseName

leaseExpirationInterval

När den anges definierar den i millisekunder det intervall för vilket lånet tas på ett lån som representerar en partition. Om lånet inte förnyas inom det här intervallet upphör det att gälla och ägarskapet för partitionen flyttas till en annan instans. Standardvärdet är 60000 (60 sekunder).

leaseExpirationInterval?: number

Egenskapsvärde

number

ärvd frånCosmosDBv3TriggerOptions.leaseExpirationInterval

leaseRenewInterval

När den anges definierar den, i millisekunder, förnyelseintervallet för alla lån för partitioner som för närvarande innehas av en instans. Standardvärdet är 17 000 (17 sekunder).

leaseRenewInterval?: number

Egenskapsvärde

number

ärvd frånCosmosDBv3TriggerOptions.leaseRenewInterval

maxItemsPerInvocation

När den här egenskapen anges anger den maximala antalet objekt som tas emot per funktionsanrop. Om åtgärder i den övervakade containern utförs via lagrade procedurer bevaras transaktionsomfånget vid läsning av objekt från ändringsflödet. Därför kan antalet mottagna objekt vara högre än det angivna värdet så att objekten som ändras av samma transaktion returneras som en del av en atomisk batch.

maxItemsPerInvocation?: number

Egenskapsvärde

number

ärvd frånCosmosDBv3TriggerOptions.maxItemsPerInvocation

preferredLocations

Definierar önskade platser (regioner) för geo-replikerade databaskonton i Azure Cosmos DB-tjänsten. Värden bör kommaavgränsas. Till exempel USA, östra, USA, södra centrala, Europa, norra

preferredLocations?: string

Egenskapsvärde

string

ärvd frånCosmosDBv3TriggerOptions.preferredLocations

return

Konfiguration för valfria primära utdata för funktionen Det här är de viktigaste utdata som du bör ange som returvärde för funktionshanteraren under anropet

return?: FunctionOutput

Egenskapsvärde

FunctionOutput

ärvd från Partial.return

startFromBeginning

Det här alternativet instruerar utlösaren att läsa ändringar från början av containerns ändringshistorik i stället för att starta vid den aktuella tidpunkten. Läsning från början fungerar bara första gången utlösaren startar, eftersom kontrollpunkterna redan lagras i efterföljande körningar. Att ange det här alternativet till sant när det redan har skapats lån har ingen effekt.

startFromBeginning?: boolean

Egenskapsvärde

boolean

ärvd frånCosmosDBv3TriggerOptions.startFromBeginning

useMultipleWriteLocations

Aktiverar konton i flera regioner för att skriva till lånesamlingen.

useMultipleWriteLocations?: boolean

Egenskapsvärde

boolean

ärvd frånCosmosDBv3TriggerOptions.useMultipleWriteLocations