CosmosDBv4TriggerOptions interface

Paket:

@azure/functions

Egenskaper

connection	En appinställning (eller miljövariabel) med Cosmos DB-anslutningssträngen
containerName	Namnet på containern som övervakas
createLeaseContainerIfNotExists	Söker efter existens och skapar automatiskt lånecontainern. Standardvärdet är false
databaseName	Namnet på Azure Cosmos DB-databasen med containern som övervakas
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).
leaseConnection	Namnet på en appinställning som innehåller anslutningssträngen till tjänsten som innehåller lånecontainern. Om den inte anges ansluter den till den tjänst som definierats av connection
leaseContainerName	Namnet på containern som ska lagra lån. Om den inte har angetts använder den "lån"
leaseContainerPrefix	När värdet anges läggs det till som ett prefix till lånen som skapats i lånecontainern för den här funktionen. Med hjälp av ett prefix kan två separata Azure Functions dela samma lånecontainer med hjälp av olika prefix.
leaseDatabaseName	Namnet på databasen som innehåller containern 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).
leasesContainerThroughput	När createLeaseContainerIfNotExists är inställt på truedefinierar mängden enheter för begäranden som ska tilldelas till den skapade lånecontainern
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
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.
startFromTime	Hämtar eller anger datum och tid från vilken ändringsflödesläsningen ska initieras. Det rekommenderade formatet är ISO 8601 med UTC-designatorn, till exempel 2021-02-16T14:19:29Z. Detta används endast för att ange det inledande utlösartillståndet. När utlösaren har ett lånetillstånd har det ingen effekt att ändra det här värdet.

Egenskapsinformation

connection

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

connection: string

Egenskapsvärde

string

containerName

Namnet på containern som övervakas

containerName: string

Egenskapsvärde

string

createLeaseContainerIfNotExists

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

createLeaseContainerIfNotExists?: boolean

Egenskapsvärde

boolean

databaseName

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

databaseName: string

Egenskapsvärde

string

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

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

leaseConnection

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

leaseConnection?: string

Egenskapsvärde

string

leaseContainerName

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

leaseContainerName?: string

Egenskapsvärde

string

leaseContainerPrefix

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

leaseContainerPrefix?: string

Egenskapsvärde

string

leaseDatabaseName

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

leaseDatabaseName?: string

Egenskapsvärde

string

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

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

leasesContainerThroughput

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

leasesContainerThroughput?: number

Egenskapsvärde

number

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

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

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

startFromTime

Hämtar eller anger datum och tid från vilken ändringsflödesläsningen ska initieras. Det rekommenderade formatet är ISO 8601 med UTC-designatorn, till exempel 2021-02-16T14:19:29Z. Detta används endast för att ange det inledande utlösartillståndet. När utlösaren har ett lånetillstånd har det ingen effekt att ändra det här värdet.

startFromTime?: string

Egenskapsvärde

string