CosmosDBv3FunctionOptions interface
- Uitbreiding
-
CosmosDBv3TriggerOptions,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
| checkpoint |
Hiermee past u de hoeveelheid documenten tussen leasecontrolepunten aan. De standaardwaarde is na elke functieaanroep. |
| checkpoint |
Wanneer deze is ingesteld, wordt het interval tussen leasecontrolepunten in milliseconden gedefinieerd. De standaardwaarde is altijd na elke functieaanroep. |
| collection |
De naam van de verzameling die wordt bewaakt |
| connection |
Een app-instelling (of omgevingsvariabele) met de Cosmos DB-verbindingsreeks |
| create |
Controleert of er bestaat en maakt automatisch de leaseverzameling. De standaardwaarde is |
| database |
De naam van de Azure Cosmos DB-database met de verzameling die wordt bewaakt |
| extra |
Configuratie voor een optionele set secundaire invoer tijdens het aanroepen: haal deze waarden op met |
| extra |
Configuratie voor een optionele set secundaire uitvoer tijdens het aanroepen stelt u deze waarden in met |
| feed |
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. |
| lease |
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). |
| lease |
De naam van de verzameling voor het opslaan van leases. Als deze niet is ingesteld, wordt gebruikgemaakt van 'leases' |
| lease |
Wanneer deze optie is ingesteld, wordt de waarde als voorvoegsel toegevoegd aan de leases die zijn gemaakt in de leaseverzameling voor deze functie. Met behulp van een voorvoegsel kunnen twee afzonderlijke Azure Functions dezelfde leaseverzameling delen met behulp van verschillende voorvoegsels. |
| lease |
Wanneer |
| lease |
De naam van een app-instelling die de verbindingsreeks bevat met de service die de leaseverzameling bevat.
Als deze niet is ingesteld, wordt er verbinding gemaakt met de service die is gedefinieerd door |
| lease |
De naam van de database die de verzameling bevat voor het opslaan van leases. Als deze niet is ingesteld, wordt de waarde van |
| lease |
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). |
| lease |
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). |
| max |
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. |
| preferred |
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 |
| start |
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. |
| use |
Hiermee kunnen accounts voor meerdere regio's worden geschreven naar de verzameling leases. |
Eigenschapdetails
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
retry?: RetryOptions
Waarde van eigenschap
trigger
Details van overgenomen eigenschap
checkpointDocumentCount
Hiermee past u de hoeveelheid documenten tussen leasecontrolepunten aan. De standaardwaarde is na elke functieaanroep.
checkpointDocumentCount?: number
Waarde van eigenschap
number
overgenomen vanCosmosDBv3TriggerOptions.checkpointDocumentCount
checkpointInterval
Wanneer deze is ingesteld, wordt het interval tussen leasecontrolepunten in milliseconden gedefinieerd. De standaardwaarde is altijd na elke functieaanroep.
checkpointInterval?: number
Waarde van eigenschap
number
overgenomen vanCosmosDBv3TriggerOptions.checkpointInterval-
collectionName
De naam van de verzameling die wordt bewaakt
collectionName: string
Waarde van eigenschap
string
overgenomen vanCosmosDBv3TriggerOptions.collectionName
connectionStringSetting
Een app-instelling (of omgevingsvariabele) met de Cosmos DB-verbindingsreeks
connectionStringSetting: string
Waarde van eigenschap
string
overgenomen vanCosmosDBv3TriggerOptions.connectionStringSetting-
createLeaseCollectionIfNotExists
Controleert of er bestaat en maakt automatisch de leaseverzameling. De standaardwaarde is false
createLeaseCollectionIfNotExists?: boolean
Waarde van eigenschap
boolean
overgenomen vanCosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists
databaseName
De naam van de Azure Cosmos DB-database met de verzameling die wordt bewaakt
databaseName: string
Waarde van eigenschap
string
overgenomen vanCosmosDBv3TriggerOptions.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
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
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 vanCosmosDBv3TriggerOptions.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 vanCosmosDBv3TriggerOptions.leaseAcquireInterval
leaseCollectionName
De naam van de verzameling voor het opslaan van leases. Als deze niet is ingesteld, wordt gebruikgemaakt van 'leases'
leaseCollectionName?: string
Waarde van eigenschap
string
overgenomen vanCosmosDBv3TriggerOptions.leaseCollectionName
leaseCollectionPrefix
Wanneer deze optie is ingesteld, wordt de waarde als voorvoegsel toegevoegd aan de leases die zijn gemaakt in de leaseverzameling voor deze functie. Met behulp van een voorvoegsel kunnen twee afzonderlijke Azure Functions dezelfde leaseverzameling delen met behulp van verschillende voorvoegsels.
leaseCollectionPrefix?: string
Waarde van eigenschap
string
overgenomen vanCosmosDBv3TriggerOptions.leaseCollectionPrefix
leaseCollectionThroughput
Wanneer createLeaseCollectionIfNotExists is ingesteld op true, definieert u het aantal aanvraageenheden dat moet worden toegewezen aan de gemaakte leaseverzameling
leaseCollectionThroughput?: number
Waarde van eigenschap
number
overgenomen vanCosmosDBv3TriggerOptions.leaseCollectionThroughput
leaseConnectionStringSetting
De naam van een app-instelling die de verbindingsreeks bevat met de service die de leaseverzameling bevat.
Als deze niet is ingesteld, wordt er verbinding gemaakt met de service die is gedefinieerd door connectionStringSetting
leaseConnectionStringSetting?: string
Waarde van eigenschap
string
overgenomen vanCosmosDBv3TriggerOptions.leaseConnectionStringSetting
leaseDatabaseName
De naam van de database die de verzameling bevat voor het opslaan van leases. Als deze niet is ingesteld, wordt de waarde van databaseName
leaseDatabaseName?: string
Waarde van eigenschap
string
overgenomen vanCosmosDBv3TriggerOptions.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 vanCosmosDBv3TriggerOptions.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 vanCosmosDBv3TriggerOptions.leaseRenewInterval-
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 vanCosmosDBv3TriggerOptions.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 vanCosmosDBv3TriggerOptions.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
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 vanCosmosDBv3TriggerOptions.startFromBeginning-
useMultipleWriteLocations
Hiermee kunnen accounts voor meerdere regio's worden geschreven naar de verzameling leases.
useMultipleWriteLocations?: boolean
Waarde van eigenschap
boolean
overgenomen vanCosmosDBv3TriggerOptions.useMultipleWriteLocations