CosmosDBv4FunctionOptions 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

connection

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

containerName

Název monitorovaného kontejneru

createLeaseContainerIfNotExists

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

databaseName

Název databáze Azure Cosmos DB s monitorovaným kontejnerem

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

leaseConnection

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

leaseContainerName

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

leaseContainerPrefix

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

leaseDatabaseName

Název databáze, která obsahuje kontejner 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).

leasesContainerThroughput

Pokud je createLeaseContainerIfNotExists nastavená na true, definuje množství jednotek žádostí, které se přiřadí vytvořenému kontejneru zapůjčení.

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.

startFromTime

Získá nebo nastaví datum a čas, ze kterého se má inicializovat operace čtení kanálu změn. Doporučený formát je ISO 8601 s designátorem UTC, například 2021-02-16T14:19:29Z. Slouží pouze k nastavení počátečního stavu triggeru. Jakmile má trigger stav zapůjčení, změna této hodnoty nemá žádný vliv.

Podrobnosti vlastnosti

handler

handler: CosmosDBv4Handler

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

Hodnota vlastnosti

Podrobnosti zděděných vlastností

connection

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

connection: string

Hodnota vlastnosti

string

zděděno zeCosmosDBv4TriggerOptions.connection

containerName

Název monitorovaného kontejneru

containerName: string

Hodnota vlastnosti

string

zděděný zCosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

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

createLeaseContainerIfNotExists?: boolean

Hodnota vlastnosti

boolean

zděděno zCosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

Název databáze Azure Cosmos DB s monitorovaným kontejnerem

databaseName: string

Hodnota vlastnosti

string

zděděno zeCosmosDBv4TriggerOptions.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ěné zCosmosDBv4TriggerOptions.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é zCosmosDBv4TriggerOptions.leaseAcquireInterval

leaseConnection

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

leaseConnection?: string

Hodnota vlastnosti

string

zděděné zCosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

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

leaseContainerName?: string

Hodnota vlastnosti

string

zděděno ze službyCosmosDBv4TriggerOptions.leaseContainerName

leaseContainerPrefix

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

leaseContainerPrefix?: string

Hodnota vlastnosti

string

zděděný zcosmosDBv4TriggerOptions.leaseContainerPrefix

leaseDatabaseName

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

leaseDatabaseName?: string

Hodnota vlastnosti

string

zděděno zeCosmosDBv4TriggerOptions.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ěné zCosmosDBv4TriggerOptions.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é zCosmosDBv4TriggerOptions.leaseRenewInterval

leasesContainerThroughput

Pokud je createLeaseContainerIfNotExists nastavená na true, definuje množství jednotek žádostí, které se přiřadí vytvořenému kontejneru zapůjčení.

leasesContainerThroughput?: number

Hodnota vlastnosti

number

zděděný zCosmosDBv4TriggerOptions.leasesContainerThroughput

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é zCosmosDBv4TriggerOptions.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ěno zeCosmosDBv4TriggerOptions.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 zeCosmosDBv4TriggerOptions.startFromBeginning

startFromTime

Získá nebo nastaví datum a čas, ze kterého se má inicializovat operace čtení kanálu změn. Doporučený formát je ISO 8601 s designátorem UTC, například 2021-02-16T14:19:29Z. Slouží pouze k nastavení počátečního stavu triggeru. Jakmile má trigger stav zapůjčení, změna této hodnoty nemá žádný vliv.

startFromTime?: string

Hodnota vlastnosti

string

zděděno zeCosmosDBv4TriggerOptions.startFromTime