CosmosDBv4FunctionOptions interface

Paket:

@azure/functions

Extends

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

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
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).
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
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.
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

handler

handler: CosmosDBv4Handler

Egenskapsvärde

CosmosDBv4Handler

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

Egenskapsvärde

CosmosDBv4Trigger

Information om ärvda egenskaper

connection

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

connection: string

Egenskapsvärde

string

ärvd frånCosmosDBv4TriggerOptions.connection

containerName

Namnet på containern som övervakas

containerName: string

Egenskapsvärde

string

ärvd frånCosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

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

createLeaseContainerIfNotExists?: boolean

Egenskapsvärde

boolean

ärvd frånCosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

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

databaseName: string

Egenskapsvärde

string

ärvd frånCosmosDBv4TriggerOptions.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ånCosmosDBv4TriggerOptions.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ånCosmosDBv4TriggerOptions.leaseAcquireInterval

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

ärvd frånCosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

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

leaseContainerName?: string

Egenskapsvärde

string

ärvd frånCosmosDBv4TriggerOptions.leaseContainerName

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

ärvd frånCosmosDBv4TriggerOptions.leaseContainerPrefix

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

ärvd frånCosmosDBv4TriggerOptions.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ånCosmosDBv4TriggerOptions.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ånCosmosDBv4TriggerOptions.leaseRenewInterval

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

ärvd frånCosmosDBv4TriggerOptions.leasesContainerThroughput

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ånCosmosDBv4TriggerOptions.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ånCosmosDBv4TriggerOptions.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ånCosmosDBv4TriggerOptions.startFromBeginning

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

ärvd frånCosmosDBv4TriggerOptions.startFromTime