CosmosDBv4FunctionOptions interface

Pakket:

@azure/functions

Uitbreiding

CosmosDBv4TriggerOptions,Partial<FunctionOptions>

Eigenschappen

handler
retry	Een optioneel beleid voor opnieuw proberen om een mislukte uitvoering opnieuw uit te voeren totdat de voltooiing is voltooid of het maximum aantal nieuwe pogingen is bereikt. Meer informatie hier
trigger

Overgenomen eigenschappen

connection	Een app-instelling (of omgevingsvariabele) met de Cosmos DB-verbindingsreeks
containerName	De naam van de container die wordt bewaakt
createLeaseContainerIfNotExists	Controleert op bestaan en maakt automatisch de leasecontainer. De standaardwaarde is false
databaseName	De naam van de Azure Cosmos DB-database met de container die wordt bewaakt
extraInputs	Configuratie voor een optionele set secundaire invoer tijdens het aanroepen: haal deze waarden op met context.extraInputs.get()
extraOutputs	Configuratie voor een optionele set secundaire uitvoer tijdens het aanroepen stelt u deze waarden in met context.extraOutputs.set()
feedPollDelay	De tijd (in milliseconden) voor de vertraging tussen het peilen van een partitie voor nieuwe wijzigingen in de feed, nadat alle huidige wijzigingen zijn leeggezogen. De standaardwaarde is 5000 milliseconden of 5 seconden.
leaseAcquireInterval	Wanneer deze optie is ingesteld, definieert deze, in milliseconden, het interval voor het starten van een taak om te berekenen of partities gelijkmatig worden verdeeld over bekende hostinstanties. De standaardwaarde is 13000 (13 seconden).
leaseConnection	De naam van een app-instelling die de verbindingsreeks bevat met de service die de leasecontainer bevat. Als deze niet is ingesteld, wordt er verbinding gemaakt met de service die is gedefinieerd door connection
leaseContainerName	De naam van de container voor het opslaan van leases. Als deze niet is ingesteld, wordt gebruikgemaakt van 'leases'
leaseContainerPrefix	Wanneer deze optie is ingesteld, wordt de waarde toegevoegd als voorvoegsel voor de leases die zijn gemaakt in de leasecontainer voor deze functie. Met behulp van een voorvoegsel kunnen twee afzonderlijke Azure Functions dezelfde Lease-container delen met behulp van verschillende voorvoegsels.
leaseDatabaseName	De naam van de database met de container voor het opslaan van leases. Als deze niet is ingesteld, wordt de waarde van databaseName
leaseExpirationInterval	Wanneer deze is ingesteld, definieert deze, in milliseconden, het interval waarvoor de lease wordt genomen in een lease die een partitie vertegenwoordigt. Als de lease niet binnen dit interval wordt vernieuwd, wordt deze verlopen en wordt het eigendom van de partitie verplaatst naar een ander exemplaar. De standaardwaarde is 60000 (60 seconden).
leaseRenewInterval	Wanneer deze is ingesteld, definieert deze, in milliseconden, het vernieuwingsinterval voor alle leases voor partities die momenteel door een exemplaar worden bewaard. De standaardwaarde is 17000 (17 seconden).
leasesContainerThroughput	Wanneer createLeaseContainerIfNotExists is ingesteld op true, definieert u het aantal aanvraageenheden dat moet worden toegewezen aan de gemaakte leasecontainer
maxItemsPerInvocation	Wanneer deze eigenschap is ingesteld, wordt het maximum aantal items ingesteld dat per functie-aanroep is ontvangen. Als bewerkingen in de bewaakte container worden uitgevoerd via opgeslagen procedures, blijft het transactiebereik behouden bij het lezen van items uit de wijzigingenfeed. Als gevolg hiervan kan het aantal ontvangen items hoger zijn dan de opgegeven waarde, zodat de items die door dezelfde transactie zijn gewijzigd, worden geretourneerd als onderdeel van één atomische batch.
preferredLocations	Definieert voorkeurslocaties (regio's) voor geo-gerepliceerde databaseaccounts in de Azure Cosmos DB-service. Waarden moeten door komma's worden gescheiden. Bijvoorbeeld VS - oost, VS - zuid-centraal, Europa - noord
return	Configuratie voor de optionele primaire uitvoer van de functie Dit is de belangrijkste uitvoer die u moet instellen als de retourwaarde van de functie-handler tijdens het aanroepen
startFromBeginning	Met deze optie wordt aan de trigger aangegeven dat wijzigingen vanaf het begin van de wijzigingsgeschiedenis van de container moeten worden gelezen in plaats van op het huidige tijdstip te beginnen. Lezen vanaf het begin werkt alleen wanneer de trigger voor het eerst wordt gestart, zoals in volgende uitvoeringen, de controlepunten al zijn opgeslagen. Het instellen van deze optie op true wanneer er al leases zijn gemaakt, heeft geen effect.
startFromTime	Hiermee haalt u de datum en tijd op van waaruit de leesbewerking van de wijzigingenfeed moet worden geïnitialiseerd. De aanbevolen indeling is ISO 8601 met de UTC-ontwerpfunctie, zoals 2021-02-16T14:19:29Z. Dit wordt alleen gebruikt om de eerste triggerstatus in te stellen. Nadat de trigger een leasestatus heeft, heeft het wijzigen van deze waarde geen effect.

Eigenschapdetails

handler

handler: CosmosDBv4Handler

Waarde van eigenschap

CosmosDBv4Handler

retry

Een optioneel beleid voor opnieuw proberen om een mislukte uitvoering opnieuw uit te voeren totdat de voltooiing is voltooid of het maximum aantal nieuwe pogingen is bereikt. Meer informatie hier

retry?: RetryOptions

Waarde van eigenschap

RetryOptions

trigger

trigger?: CosmosDBv4Trigger

Waarde van eigenschap

CosmosDBv4Trigger

Details van overgenomen eigenschap

connection

Een app-instelling (of omgevingsvariabele) met de Cosmos DB-verbindingsreeks

connection: string

Waarde van eigenschap

string

overgenomen vanCosmosDBv4TriggerOptions.connection

containerName

De naam van de container die wordt bewaakt

containerName: string

Waarde van eigenschap

string

overgenomen vanCosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

Controleert op bestaan en maakt automatisch de leasecontainer. De standaardwaarde is false

createLeaseContainerIfNotExists?: boolean

Waarde van eigenschap

boolean

overgenomen vanCosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

De naam van de Azure Cosmos DB-database met de container die wordt bewaakt

databaseName: string

Waarde van eigenschap

string

overgenomen vanCosmosDBv4TriggerOptions.databaseName

extraInputs

Configuratie voor een optionele set secundaire invoer tijdens het aanroepen: haal deze waarden op met context.extraInputs.get()

extraInputs?: FunctionInput[]

Waarde van eigenschap

FunctionInput[]

overgenomen van Partial.extraInputs

extraOutputs

Configuratie voor een optionele set secundaire uitvoer tijdens het aanroepen stelt u deze waarden in met context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Waarde van eigenschap

FunctionOutput[]

overgenomen van Partial.extraOutputs

feedPollDelay

De tijd (in milliseconden) voor de vertraging tussen het peilen van een partitie voor nieuwe wijzigingen in de feed, nadat alle huidige wijzigingen zijn leeggezogen. De standaardwaarde is 5000 milliseconden of 5 seconden.

feedPollDelay?: number

Waarde van eigenschap

number

overgenomen vanCosmosDBv4TriggerOptions.feedPollDelay-

leaseAcquireInterval

Wanneer deze optie is ingesteld, definieert deze, in milliseconden, het interval voor het starten van een taak om te berekenen of partities gelijkmatig worden verdeeld over bekende hostinstanties. De standaardwaarde is 13000 (13 seconden).

leaseAcquireInterval?: number

Waarde van eigenschap

number

overgenomen vanCosmosDBv4TriggerOptions.leaseAcquireInterval

leaseConnection

De naam van een app-instelling die de verbindingsreeks bevat met de service die de leasecontainer bevat. Als deze niet is ingesteld, wordt er verbinding gemaakt met de service die is gedefinieerd door connection

leaseConnection?: string

Waarde van eigenschap

string

overgenomen vanCosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

De naam van de container voor het opslaan van leases. Als deze niet is ingesteld, wordt gebruikgemaakt van 'leases'

leaseContainerName?: string

Waarde van eigenschap

string

overgenomen vanCosmosDBv4TriggerOptions.leaseContainerName

leaseContainerPrefix

Wanneer deze optie is ingesteld, wordt de waarde toegevoegd als voorvoegsel voor de leases die zijn gemaakt in de leasecontainer voor deze functie. Met behulp van een voorvoegsel kunnen twee afzonderlijke Azure Functions dezelfde Lease-container delen met behulp van verschillende voorvoegsels.

leaseContainerPrefix?: string

Waarde van eigenschap

string

overgenomen vanCosmosDBv4TriggerOptions.leaseContainerPrefix

leaseDatabaseName

De naam van de database met de container voor het opslaan van leases. Als deze niet is ingesteld, wordt de waarde van databaseName

leaseDatabaseName?: string

Waarde van eigenschap

string

overgenomen vanCosmosDBv4TriggerOptions.leaseDatabaseName

leaseExpirationInterval

Wanneer deze is ingesteld, definieert deze, in milliseconden, het interval waarvoor de lease wordt genomen in een lease die een partitie vertegenwoordigt. Als de lease niet binnen dit interval wordt vernieuwd, wordt deze verlopen en wordt het eigendom van de partitie verplaatst naar een ander exemplaar. De standaardwaarde is 60000 (60 seconden).

leaseExpirationInterval?: number

Waarde van eigenschap

number

overgenomen vanCosmosDBv4TriggerOptions.leaseExpirationInterval

leaseRenewInterval

Wanneer deze is ingesteld, definieert deze, in milliseconden, het vernieuwingsinterval voor alle leases voor partities die momenteel door een exemplaar worden bewaard. De standaardwaarde is 17000 (17 seconden).

leaseRenewInterval?: number

Waarde van eigenschap

number

overgenomen vanCosmosDBv4TriggerOptions.leaseRenewInterval-

leasesContainerThroughput

Wanneer createLeaseContainerIfNotExists is ingesteld op true, definieert u het aantal aanvraageenheden dat moet worden toegewezen aan de gemaakte leasecontainer

leasesContainerThroughput?: number

Waarde van eigenschap

number

overgenomen vanCosmosDBv4TriggerOptions.leasesContainerThroughput

maxItemsPerInvocation

Wanneer deze eigenschap is ingesteld, wordt het maximum aantal items ingesteld dat per functie-aanroep is ontvangen. Als bewerkingen in de bewaakte container worden uitgevoerd via opgeslagen procedures, blijft het transactiebereik behouden bij het lezen van items uit de wijzigingenfeed. Als gevolg hiervan kan het aantal ontvangen items hoger zijn dan de opgegeven waarde, zodat de items die door dezelfde transactie zijn gewijzigd, worden geretourneerd als onderdeel van één atomische batch.

maxItemsPerInvocation?: number

Waarde van eigenschap

number

overgenomen vanCosmosDBv4TriggerOptions.maxItemsPerInvocation

preferredLocations

Definieert voorkeurslocaties (regio's) voor geo-gerepliceerde databaseaccounts in de Azure Cosmos DB-service. Waarden moeten door komma's worden gescheiden. Bijvoorbeeld VS - oost, VS - zuid-centraal, Europa - noord

preferredLocations?: string

Waarde van eigenschap

string

overgenomen vanCosmosDBv4TriggerOptions.preferredLocations

return

Configuratie voor de optionele primaire uitvoer van de functie Dit is de belangrijkste uitvoer die u moet instellen als de retourwaarde van de functie-handler tijdens het aanroepen

return?: FunctionOutput

Waarde van eigenschap

FunctionOutput

overgenomen van Partial.return

startFromBeginning

Met deze optie wordt aan de trigger aangegeven dat wijzigingen vanaf het begin van de wijzigingsgeschiedenis van de container moeten worden gelezen in plaats van op het huidige tijdstip te beginnen. Lezen vanaf het begin werkt alleen wanneer de trigger voor het eerst wordt gestart, zoals in volgende uitvoeringen, de controlepunten al zijn opgeslagen. Het instellen van deze optie op true wanneer er al leases zijn gemaakt, heeft geen effect.

startFromBeginning?: boolean

Waarde van eigenschap

boolean

overgenomen vanCosmosDBv4TriggerOptions.startFromBeginning-

startFromTime

Hiermee haalt u de datum en tijd op van waaruit de leesbewerking van de wijzigingenfeed moet worden geïnitialiseerd. De aanbevolen indeling is ISO 8601 met de UTC-ontwerpfunctie, zoals 2021-02-16T14:19:29Z. Dit wordt alleen gebruikt om de eerste triggerstatus in te stellen. Nadat de trigger een leasestatus heeft, heeft het wijzigen van deze waarde geen effect.

startFromTime?: string

Waarde van eigenschap

string

overgenomen vanCosmosDBv4TriggerOptions.startFromTime-