CosmosDBv3FunctionOptions interface

handler: CosmosDBv3Handler

Eigenschaftswert

Eine optionale Wiederholungsrichtlinie, um eine fehlgeschlagene Ausführung erneut auszuführen, bis entweder der erfolgreiche Abschluss erfolgt oder die maximale Anzahl von Wiederholungen erreicht ist. Weitere hier

retry?: RetryOptions

Eigenschaftswert

trigger?: CosmosDBv3Trigger

Eigenschaftswert

Passt die Anzahl der Dokumente zwischen Leaseprüfpunkten an. Der Standardwert liegt nach jedem Funktionsaufruf.

checkpointDocumentCount?: number

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.checkpointDocumentCount

Wenn festgelegt, definiert sie in Millisekunden das Intervall zwischen Leaseprüfpunkten. Der Standardwert ist immer nach jedem Funktionsaufruf.

checkpointInterval?: number

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.checkpointInterval

Der Name der überwachten Auflistung

collectionName: string

Eigenschaftswert

Geerbt vonCosmosDBv3TriggerOptions.collectionName

Eine App-Einstellung (oder Umgebungsvariable) mit der Cosmos DB-Verbindungszeichenfolge

connectionStringSetting: string

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.connectionStringSetting

Überprüft auf das Vorhandensein und erstellt automatisch die Leasesauflistung. Der Standardwert ist false

createLeaseCollectionIfNotExists?: boolean

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

Der Name der Azure Cosmos DB-Datenbank mit der zu überwachenden Sammlung

databaseName: string

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.databaseName

Konfiguration für einen optionalen Satz sekundärer Eingaben während des Aufrufs erhalten Sie diese Werte mit context.extraInputs.get()

extraInputs?: FunctionInput[]

Eigenschaftswert

geerbt von Partial.extraInputs

Konfiguration für einen optionalen Satz von sekundären Ausgaben während des Aufrufs, legen Sie diese Werte mit context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Eigenschaftswert

geerbt von Partial.extraOutputs

Die Zeit (in Millisekunden) für die Verzögerung zwischen dem Abrufen einer Partition für neue Änderungen am Feed, nachdem alle aktuellen Änderungen entwässert wurden. Der Standardwert ist 5.000 Millisekunden oder 5 Sekunden.

feedPollDelay?: number

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.feedPollDelay

Wenn festgelegt, definiert es in Millisekunden das Intervall, um eine Aufgabe zu starten, um zu berechnen, ob Partitionen gleichmäßig auf bekannte Hostinstanzen verteilt werden. Der Standardwert ist 13000 (13 Sekunden).

leaseAcquireInterval?: number

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.leaseAcquireInterval

Der Name der Sammlung zum Speichern von Leases. Wenn nicht festgelegt, wird "Leases" verwendet.

leaseCollectionName?: string

Eigenschaftswert

Geerbt vonCosmosDBv3TriggerOptions.leaseCollectionName

Bei Festlegung wird der Wert als Präfix zu den Leases hinzugefügt, die in der Lease-Auflistung für diese Funktion erstellt wurden. Durch die Verwendung eines Präfixes können zwei separate Azure Functions dieselbe Lease-Auflistung mit unterschiedlichen Präfixen gemeinsam nutzen.

leaseCollectionPrefix?: string

Eigenschaftswert

vonCosmosDBv3TriggerOptions.leaseCollectionPrefix geerbt

Wenn createLeaseCollectionIfNotExists auf truefestgelegt ist, definiert die Anzahl der Anforderungseinheiten, die der erstellten Leaseauflistung zugewiesen werden sollen.

leaseCollectionThroughput?: number

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.leaseCollectionThroughput

Der Name einer App-Einstellung, die die Verbindungszeichenfolge mit dem Dienst enthält, der die Leaseauflistung enthält. Wenn sie nicht festgelegt ist, wird eine Verbindung mit dem von connectionStringSetting definierten Dienst hergestellt.

leaseConnectionStringSetting?: string

Eigenschaftswert

vonCosmosDBv3TriggerOptions.leaseConnectionStringSetting

Der Name der Datenbank, die die Sammlung zum Speichern von Leases enthält. Wenn sie nicht festgelegt ist, wird der Wert von databaseName

leaseDatabaseName?: string

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.leaseDatabaseName

Wenn festgelegt, definiert sie in Millisekunden das Intervall, für das die Lease für eine Lease übernommen wird, die eine Partition darstellt. Wenn die Lease innerhalb dieses Intervalls nicht verlängert wird, läuft sie ab, und der Besitz der Partition wird zu einer anderen Instanz verschoben. Der Standardwert ist 60000 (60 Sekunden).

leaseExpirationInterval?: number

Eigenschaftswert

vonCosmosDBv3TriggerOptions.leaseExpirationInterval

Wenn festgelegt, definiert sie in Millisekunden das Verlängerungsintervall für alle Leases für Partitionen, die derzeit von einer Instanz gehalten werden. Der Standardwert ist 17000 (17 Sekunden).

leaseRenewInterval?: number

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.leaseRenewInterval

Bei Festlegung legt diese Eigenschaft die maximale Anzahl der pro Funktionsaufruf empfangenen Elemente fest. Wenn Vorgänge im überwachten Container über gespeicherte Prozeduren ausgeführt werden, wird der Transaktionsbereich beim Lesen von Elementen aus dem Änderungsfeed beibehalten. Daher könnte die Anzahl der empfangenen Elemente höher als der angegebene Wert sein, sodass die von derselben Transaktion geänderten Elemente als Teil eines Atombatches zurückgegeben werden.

maxItemsPerInvocation?: number

Eigenschaftswert

Geerbt vonCosmosDBv3TriggerOptions.maxItemsPerInvocation

Definiert bevorzugte Standorte (Regionen) für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst. Werte sollten durch Trennzeichen getrennt sein. Beispiel: Ost-USA,Süd-Mittel-USA,Nordeuropa

preferredLocations?: string

Eigenschaftswert

Geerbt vonCosmosDBv3TriggerOptions.preferredLocations

Konfiguration für die optionale primäre Ausgabe der Funktion Dies ist die Hauptausgabe, die Sie während des Aufrufs als Rückgabewert des Funktionshandlers festlegen sollten.

return?: FunctionOutput

Eigenschaftswert

Geerbt von Partial.return

Diese Option weist den Trigger an, Änderungen vom Anfang des Änderungsverlaufs des Containers zu lesen, anstatt zur aktuellen Zeit zu beginnen. Das Lesen von Anfang an funktioniert nur, wenn der Trigger zum ersten Mal gestartet wird, wie in nachfolgenden Läufen, die Prüfpunkte bereits gespeichert sind. Das Festlegen dieser Option auf "true", wenn bereits erstellte Leases vorhanden sind, hat keine Auswirkung.

startFromBeginning?: boolean

Eigenschaftswert

geerbt vonCosmosDBv3TriggerOptions.startFromBeginning

Ermöglicht Multi-Region-Konten zum Schreiben in die Leasessammlung.

useMultipleWriteLocations?: boolean

Eigenschaftswert

Geerbt vonCosmosDBv3TriggerOptions.useMultipleWriteLocations