CosmosDBv4FunctionOptions interface

handler: CosmosDBv4Handler

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

Eigenschaftswert

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

connection: string

Eigenschaftswert

geerbt vonCosmosDBv4TriggerOptions.connection

Der Name des überwachten Containers

containerName: string

Eigenschaftswert

vonCosmosDBv4TriggerOptions.containerName

Überprüft das Vorhandensein und erstellt automatisch den Leasecontainer. Der Standardwert ist false

createLeaseContainerIfNotExists?: boolean

Eigenschaftswert

geerbt vonCosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

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

databaseName: string

Eigenschaftswert

vonCosmosDBv4TriggerOptions.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 vonCosmosDBv4TriggerOptions.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 vonCosmosDBv4TriggerOptions.leaseAcquireInterval

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

leaseConnection?: string

Eigenschaftswert

geerbt vonCosmosDBv4TriggerOptions.leaseConnection

Der Name des Containers zum Speichern von Leases. Wenn nicht festgelegt, wird "Leases" verwendet.

leaseContainerName?: string

Eigenschaftswert

geerbt vonCosmosDBv4TriggerOptions.leaseContainerName

Bei Festlegung wird der Wert als Präfix zu den im Leasecontainer für diese Funktion erstellten Leases hinzugefügt. Durch die Verwendung eines Präfixes können zwei separate Azure-Funktionen denselben Leasecontainer mit unterschiedlichen Präfixen gemeinsam nutzen.

leaseContainerPrefix?: string

Eigenschaftswert

vonCosmosDBv4TriggerOptions.leaseContainerPrefix geerbt

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

leaseDatabaseName?: string

Eigenschaftswert

geerbt vonCosmosDBv4TriggerOptions.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

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

vonCosmosDBv4TriggerOptions.leaseRenewInterval

Wenn createLeaseContainerIfNotExists auf truefestgelegt ist, definiert die Anzahl der Anforderungseinheiten, die dem erstellten Leasecontainer zugewiesen werden sollen.

leasesContainerThroughput?: number

Eigenschaftswert

Geerbt vonCosmosDBv4TriggerOptions.leasesContainerThroughput

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 vonCosmosDBv4TriggerOptions.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 vonCosmosDBv4TriggerOptions.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 vonCosmosDBv4TriggerOptions.startFromBeginning

Dient zum Abrufen oder Festlegen des Datums und der Uhrzeit zum Initialisieren des Änderungsfeedlesevorgangs. Das empfohlene Format ist ISO 8601 mit dem UTC-Kennzeichner, z. B. 2021-02-16T14:19:29Z. Dies wird nur verwendet, um den anfänglichen Triggerzustand festzulegen. Nachdem der Auslöser einen Leasestatus aufweist, hat das Ändern dieses Werts keine Auswirkung.

startFromTime?: string

Eigenschaftswert

Geerbt vonCosmosDBv4TriggerOptions.startFromTime-