CosmosDBv3FunctionOptions interface

Extends

Vlastnosti

handler
retry

Nepovinná zásada opakování pro opětovné spuštění neúspěšného spuštění, dokud nedojde k úspěšnému dokončení nebo dosažení maximálního počtu opakování. Další informace

trigger

Zděděné vlastnosti

checkpointDocumentCount

Přizpůsobí množství dokumentů mezi kontrolními body zapůjčení. Výchozí hodnota je po každém volání funkce.

checkpointInterval

Při nastavení definuje interval mezi kontrolními body zapůjčení v milisekundách. Výchozí hodnota je vždy po každém volání funkce.

collectionName

Název monitorované kolekce

connectionStringSetting

Nastavení aplikace (nebo proměnná prostředí) s připojovacím řetězcem cosmos DB

createLeaseCollectionIfNotExists

Kontroluje existenci a automaticky vytvoří kolekci zapůjčení. Výchozí hodnota je false

databaseName

Název databáze Azure Cosmos DB s monitorovanou kolekcí

extraInputs

Konfigurace pro volitelnou sadu sekundárních vstupů Během vyvolání získejte tyto hodnoty pomocí context.extraInputs.get()

extraOutputs

Konfigurace pro volitelnou sadu sekundárních výstupů Během vyvolání nastavte tyto hodnoty pomocí context.extraOutputs.set()

feedPollDelay

Čas (v milisekundách) zpoždění mezi dotazováním oddílu na nové změny v informačním kanálu po vyprázdnění všech aktuálních změn. Výchozí hodnota je 5 000 milisekund nebo 5 sekund.

leaseAcquireInterval

Když nastavíte, definuje interval v milisekundách, aby se úloha vypočítala, pokud se oddíly rovnoměrně distribuují mezi známé instance hostitele. Výchozí hodnota je 13000 (13 sekund).

leaseCollectionName

Název kolekce pro ukládání zapůjčení. Pokud není nastavená, použije se "zapůjčení".

leaseCollectionPrefix

Při nastavení se hodnota přidá jako předpona zapůjčení vytvořeným v kolekci Zapůjčení pro tuto funkci. Použití předpony umožňuje dvěma samostatným funkcím Azure Functions sdílet stejnou kolekci zapůjčení pomocí různých předpon.

leaseCollectionThroughput

Pokud je createLeaseCollectionIfNotExists nastavená na true, definuje množství jednotek žádostí, které se mají přiřadit k vytvořené kolekci zapůjčení.

leaseConnectionStringSetting

Název nastavení aplikace, které obsahuje připojovací řetězec ke službě, která obsahuje kolekci zapůjčení. Pokud ho nenastavíte, připojí se ke službě definované connectionStringSetting

leaseDatabaseName

Název databáze, která obsahuje kolekci pro ukládání zapůjčení. Pokud není nastavená, použije se hodnota databaseName

leaseExpirationInterval

Při nastavení definuje v milisekundách interval, pro který se zapůjčení převezme na zapůjčení představující oddíl. Pokud se zapůjčení neprodloužilo v tomto intervalu, způsobí to vypršení platnosti oddílu a vlastnictví oddílu se přesune do jiné instance. Výchozí hodnota je 60000 (60 sekund).

leaseRenewInterval

Při nastavení definuje interval obnovení pro všechna zapůjčení oddílů, které jsou aktuálně uloženy instancí, v milisekundách. Výchozí hodnota je 17000 (17 sekund).

maxItemsPerInvocation

Při nastavení nastaví tato vlastnost maximální počet položek přijatých na volání funkce. Pokud se operace v monitorovaném kontejneru provádějí prostřednictvím uložených procedur, při čtení položek z kanálu změn se obor transakcí zachovají. V důsledku toho může být počet přijatých položek vyšší než zadaná hodnota, aby položky změněné stejnou transakcí byly vráceny jako součást jedné atomické dávky.

preferredLocations

Definuje upřednostňovaná umístění (oblasti) pro geograficky replikované databázové účty ve službě Azure Cosmos DB. Hodnoty by měly být oddělené čárkami. Například USA – východ, USA – středojiž, Severní Evropa

return

Konfigurace volitelného primárního výstupu funkce Toto je hlavní výstup, který byste měli nastavit jako návratové hodnoty obslužné rutiny funkce během volání.

startFromBeginning

Tato možnost dává triggeru pokyn ke čtení změn od začátku historie změn kontejneru, nikoli od aktuálního času. Čtení od začátku funguje jenom při prvním spuštění triggeru, protože v následných spuštěních jsou kontrolní body už uložené. Nastavení této možnosti na hodnotu true, pokud již vytvořené zapůjčení nemá žádný vliv.

useMultipleWriteLocations

Umožňuje více oblastí účtům pro zápis do kolekce zapůjčení.

Podrobnosti vlastnosti

handler

handler: CosmosDBv3Handler

Hodnota vlastnosti

retry

Nepovinná zásada opakování pro opětovné spuštění neúspěšného spuštění, dokud nedojde k úspěšnému dokončení nebo dosažení maximálního počtu opakování. Další informace

retry?: RetryOptions

Hodnota vlastnosti

trigger

trigger?: CosmosDBv3Trigger

Hodnota vlastnosti

Podrobnosti zděděných vlastností

checkpointDocumentCount

Přizpůsobí množství dokumentů mezi kontrolními body zapůjčení. Výchozí hodnota je po každém volání funkce.

checkpointDocumentCount?: number

Hodnota vlastnosti

number

zděděno zCosmosDBv3TriggerOptions.checkpointDocumentCount

checkpointInterval

Při nastavení definuje interval mezi kontrolními body zapůjčení v milisekundách. Výchozí hodnota je vždy po každém volání funkce.

checkpointInterval?: number

Hodnota vlastnosti

number

zděděné zCosmosDBv3TriggerOptions.checkpointInterval

collectionName

Název monitorované kolekce

collectionName: string

Hodnota vlastnosti

string

zděděné zCosmosDBv3TriggerOptions.collectionName

connectionStringSetting

Nastavení aplikace (nebo proměnná prostředí) s připojovacím řetězcem cosmos DB

connectionStringSetting: string

Hodnota vlastnosti

string

zděděno zeCosmosDBv3TriggerOptions.connectionStringSetting

createLeaseCollectionIfNotExists

Kontroluje existenci a automaticky vytvoří kolekci zapůjčení. Výchozí hodnota je false

createLeaseCollectionIfNotExists?: boolean

Hodnota vlastnosti

boolean

zděděno zCosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

databaseName

Název databáze Azure Cosmos DB s monitorovanou kolekcí

databaseName: string

Hodnota vlastnosti

string

zděděno zeCosmosDBv3TriggerOptions.databaseName

extraInputs

Konfigurace pro volitelnou sadu sekundárních vstupů Během vyvolání získejte tyto hodnoty pomocí context.extraInputs.get()

extraInputs?: FunctionInput[]

Hodnota vlastnosti

zděděno z Partial.extraInputs

extraOutputs

Konfigurace pro volitelnou sadu sekundárních výstupů Během vyvolání nastavte tyto hodnoty pomocí context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Hodnota vlastnosti

zděděno z Partial.extraOutputs

feedPollDelay

Čas (v milisekundách) zpoždění mezi dotazováním oddílu na nové změny v informačním kanálu po vyprázdnění všech aktuálních změn. Výchozí hodnota je 5 000 milisekund nebo 5 sekund.

feedPollDelay?: number

Hodnota vlastnosti

number

zděděno zeCosmosDBv3TriggerOptions.feedPollDelay

leaseAcquireInterval

Když nastavíte, definuje interval v milisekundách, aby se úloha vypočítala, pokud se oddíly rovnoměrně distribuují mezi známé instance hostitele. Výchozí hodnota je 13000 (13 sekund).

leaseAcquireInterval?: number

Hodnota vlastnosti

number

zděděné zCosmosDBv3TriggerOptions.leaseAcquireInterval

leaseCollectionName

Název kolekce pro ukládání zapůjčení. Pokud není nastavená, použije se "zapůjčení".

leaseCollectionName?: string

Hodnota vlastnosti

string

zděděno zeCosmosDBv3TriggerOptions.leaseCollectionName

leaseCollectionPrefix

Při nastavení se hodnota přidá jako předpona zapůjčení vytvořeným v kolekci Zapůjčení pro tuto funkci. Použití předpony umožňuje dvěma samostatným funkcím Azure Functions sdílet stejnou kolekci zapůjčení pomocí různých předpon.

leaseCollectionPrefix?: string

Hodnota vlastnosti

string

zděděno zeCosmosDBv3TriggerOptions.leaseCollectionPrefix

leaseCollectionThroughput

Pokud je createLeaseCollectionIfNotExists nastavená na true, definuje množství jednotek žádostí, které se mají přiřadit k vytvořené kolekci zapůjčení.

leaseCollectionThroughput?: number

Hodnota vlastnosti

number

zděděné zCosmosDBv3TriggerOptions.leaseCollectionThroughput

leaseConnectionStringSetting

Název nastavení aplikace, které obsahuje připojovací řetězec ke službě, která obsahuje kolekci zapůjčení. Pokud ho nenastavíte, připojí se ke službě definované connectionStringSetting

leaseConnectionStringSetting?: string

Hodnota vlastnosti

string

zděděno zeCosmosDBv3TriggerOptions.leaseConnectionStringSetting

leaseDatabaseName

Název databáze, která obsahuje kolekci pro ukládání zapůjčení. Pokud není nastavená, použije se hodnota databaseName

leaseDatabaseName?: string

Hodnota vlastnosti

string

zděděno zCosmosDBv3TriggerOptions.leaseDatabaseName

leaseExpirationInterval

Při nastavení definuje v milisekundách interval, pro který se zapůjčení převezme na zapůjčení představující oddíl. Pokud se zapůjčení neprodloužilo v tomto intervalu, způsobí to vypršení platnosti oddílu a vlastnictví oddílu se přesune do jiné instance. Výchozí hodnota je 60000 (60 sekund).

leaseExpirationInterval?: number

Hodnota vlastnosti

number

zděděno zeCosmosDBv3TriggerOptions.leaseExpirationInterval

leaseRenewInterval

Při nastavení definuje interval obnovení pro všechna zapůjčení oddílů, které jsou aktuálně uloženy instancí, v milisekundách. Výchozí hodnota je 17000 (17 sekund).

leaseRenewInterval?: number

Hodnota vlastnosti

number

zděděné zCosmosDBv3TriggerOptions.leaseRenewInterval

maxItemsPerInvocation

Při nastavení nastaví tato vlastnost maximální počet položek přijatých na volání funkce. Pokud se operace v monitorovaném kontejneru provádějí prostřednictvím uložených procedur, při čtení položek z kanálu změn se obor transakcí zachovají. V důsledku toho může být počet přijatých položek vyšší než zadaná hodnota, aby položky změněné stejnou transakcí byly vráceny jako součást jedné atomické dávky.

maxItemsPerInvocation?: number

Hodnota vlastnosti

number

zděděné zCosmosDBv3TriggerOptions.maxItemsPerInvocation

preferredLocations

Definuje upřednostňovaná umístění (oblasti) pro geograficky replikované databázové účty ve službě Azure Cosmos DB. Hodnoty by měly být oddělené čárkami. Například USA – východ, USA – středojiž, Severní Evropa

preferredLocations?: string

Hodnota vlastnosti

string

zděděné zCosmosDBv3TriggerOptions.preferredLocations

return

Konfigurace volitelného primárního výstupu funkce Toto je hlavní výstup, který byste měli nastavit jako návratové hodnoty obslužné rutiny funkce během volání.

return?: FunctionOutput

Hodnota vlastnosti

zděděno ze Partial.return

startFromBeginning

Tato možnost dává triggeru pokyn ke čtení změn od začátku historie změn kontejneru, nikoli od aktuálního času. Čtení od začátku funguje jenom při prvním spuštění triggeru, protože v následných spuštěních jsou kontrolní body už uložené. Nastavení této možnosti na hodnotu true, pokud již vytvořené zapůjčení nemá žádný vliv.

startFromBeginning?: boolean

Hodnota vlastnosti

boolean

zděděno zeCosmosDBv3TriggerOptions.startFromBeginning

useMultipleWriteLocations

Umožňuje více oblastí účtům pro zápis do kolekce zapůjčení.

useMultipleWriteLocations?: boolean

Hodnota vlastnosti

boolean

zděděné zCosmosDBv3TriggerOptions.useMultipleWriteLocations