CosmosDBv3FunctionOptions interface

Pakiet:

@azure/functions

Rozszerzenie

CosmosDBv3TriggerOptions,Partial<FunctionOptions>

Właściwości

handler
retry	Opcjonalne zasady ponawiania prób w celu ponownego uruchomienia wykonania zakończonego niepowodzeniem do momentu pomyślnego ukończenia lub osiągnięcia maksymalnej liczby ponownych prób. Dowiedz się więcej tutaj
trigger

Właściwości dziedziczone

checkpointDocumentCount	Dostosowuje ilość dokumentów między punktami kontrolnymi dzierżawy. Wartość domyślna jest po każdym wywołaniu funkcji.
checkpointInterval	Po ustawieniu definiuje interwał między punktami kontrolnymi dzierżawy w milisekundach. Wartość domyślna jest zawsze po każdym wywołaniu funkcji.
collectionName	Nazwa monitorowanej kolekcji
connectionStringSetting	Ustawienie aplikacji (lub zmienna środowiskowa) z parametrami połączenia usługi Cosmos DB
createLeaseCollectionIfNotExists	Sprawdza istnienie i automatycznie tworzy kolekcję dzierżaw. Wartość domyślna to false
databaseName	Nazwa bazy danych usługi Azure Cosmos DB z monitorowaną kolekcją
extraInputs	Konfiguracja opcjonalnego zestawu pomocniczych danych wejściowych Podczas wywołania pobierz te wartości przy użyciu context.extraInputs.get()
extraOutputs	Konfiguracja opcjonalnego zestawu pomocniczych danych wyjściowych podczas wywołania ustaw te wartości przy użyciu context.extraOutputs.set()
feedPollDelay	Czas (w milisekundach) dla opóźnienia między sondowaniem partycji pod kątem nowych zmian w kanale informacyjnym, po opróżnieniu wszystkich bieżących zmian. Wartość domyślna to 5000 milisekund lub 5 sekund.
leaseAcquireInterval	Po ustawieniu definiuje, w milisekundach, interwał uruchamiania zadania obliczeniowego, jeśli partycje są równomiernie dystrybuowane między znane wystąpienia hosta. Wartość domyślna to 13000 (13 sekund).
leaseCollectionName	Nazwa kolekcji do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, będzie ona używać "dzierżaw"
leaseCollectionPrefix	Po ustawieniu wartość jest dodawana jako prefiks do dzierżaw utworzonych w kolekcji Dzierżawy dla tej funkcji. Użycie prefiksu umożliwia dwóm oddzielnym funkcjom usługi Azure Functions współużytkowania tej samej kolekcji dzierżaw przy użyciu różnych prefiksów.
leaseCollectionThroughput	Gdy createLeaseCollectionIfNotExists jest ustawiona na true, definiuje liczbę jednostek żądań do przypisania do utworzonej kolekcji dzierżaw
leaseConnectionStringSetting	Nazwa ustawienia aplikacji zawierającego parametry połączenia z usługą, która przechowuje kolekcję dzierżaw. Jeśli nie zostanie ustawiona, połączy się z usługą zdefiniowaną przez connectionStringSetting
leaseDatabaseName	Nazwa bazy danych, która przechowuje kolekcję do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość databaseName
leaseExpirationInterval	Po ustawieniu definiuje, w milisekundach, interwał, dla którego dzierżawa jest wykonywana w dzierżawie reprezentującej partycję. Jeśli dzierżawa nie zostanie odnowiona w tym interwale, spowoduje to wygaśnięcie, a własność partycji zostanie przeniesiona do innego wystąpienia. Wartość domyślna to 60000 (60 sekund).
leaseRenewInterval	Po ustawieniu definiuje, w milisekundach, interwał odnawiania dla wszystkich dzierżaw dla partycji, które są obecnie przechowywane przez wystąpienie. Wartość domyślna to 17000 (17 sekund).
maxItemsPerInvocation	Po ustawieniu ta właściwość ustawia maksymalną liczbę odebranych elementów na wywołanie funkcji. Jeśli operacje w monitorowanym kontenerze są wykonywane za pomocą procedur składowanych, zakres transakcji jest zachowywany podczas odczytywania elementów ze źródła zmian. W związku z tym liczba odebranych elementów może być większa niż określona wartość, aby elementy zmienione przez tę samą transakcję zostały zwrócone w ramach jednej partii niepodzielnej.
preferredLocations	Definiuje preferowane lokalizacje (regiony) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB. Wartości powinny być rozdzielane przecinkami. Na przykład Wschodnie stany USA, Południowo-środkowe stany USA, Europa Północna
return	Konfiguracja opcjonalnych podstawowych danych wyjściowych funkcji Jest to główne dane wyjściowe, które należy ustawić jako wartość zwracaną programu obsługi funkcji podczas wywołania
startFromBeginning	Ta opcja nakazuje wyzwalaczowi odczytywanie zmian od początku historii zmian kontenera zamiast rozpoczynania się od bieżącej godziny. Odczyt od początku działa tylko przy pierwszym uruchomieniu wyzwalacza, tak jak w kolejnych uruchomieniach, punkty kontrolne są już przechowywane. Ustawienie tej opcji na wartość true, jeśli istnieją już utworzone dzierżawy, nie ma wpływu.
useMultipleWriteLocations	Umożliwia zapisywanie kont w wielu regionach w kolekcji dzierżaw.

Szczegóły właściwości

handler

handler: CosmosDBv3Handler

Wartość właściwości

CosmosDBv3Handler

retry

Opcjonalne zasady ponawiania prób w celu ponownego uruchomienia wykonania zakończonego niepowodzeniem do momentu pomyślnego ukończenia lub osiągnięcia maksymalnej liczby ponownych prób. Dowiedz się więcej tutaj

retry?: RetryOptions

Wartość właściwości

RetryOptions

trigger

trigger?: CosmosDBv3Trigger

Wartość właściwości

CosmosDBv3Trigger

Szczegóły właściwości dziedziczonej

checkpointDocumentCount

Dostosowuje ilość dokumentów między punktami kontrolnymi dzierżawy. Wartość domyślna jest po każdym wywołaniu funkcji.

checkpointDocumentCount?: number

Wartość właściwości

number

dziedziczone zCosmosDBv3TriggerOptions.checkpointDocumentCount

checkpointInterval

Po ustawieniu definiuje interwał między punktami kontrolnymi dzierżawy w milisekundach. Wartość domyślna jest zawsze po każdym wywołaniu funkcji.

checkpointInterval?: number

Wartość właściwości

number

dziedziczone zCosmosDBv3TriggerOptions.checkpointInterval

collectionName

Nazwa monitorowanej kolekcji

collectionName: string

Wartość właściwości

string

dziedziczone zCosmosDBv3TriggerOptions.collectionName

connectionStringSetting

Ustawienie aplikacji (lub zmienna środowiskowa) z parametrami połączenia usługi Cosmos DB

connectionStringSetting: string

Wartość właściwości

string

dziedziczone zCosmosDBv3TriggerOptions.connectionStringSetting

createLeaseCollectionIfNotExists

Sprawdza istnienie i automatycznie tworzy kolekcję dzierżaw. Wartość domyślna to false

createLeaseCollectionIfNotExists?: boolean

Wartość właściwości

boolean

dziedziczone zCosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

databaseName

Nazwa bazy danych usługi Azure Cosmos DB z monitorowaną kolekcją

databaseName: string

Wartość właściwości

string

dziedziczone zCosmosDBv3TriggerOptions.databaseName

extraInputs

Konfiguracja opcjonalnego zestawu pomocniczych danych wejściowych Podczas wywołania pobierz te wartości przy użyciu context.extraInputs.get()

extraInputs?: FunctionInput[]

Wartość właściwości

FunctionInput[]

dziedziczone z Partial.extraInputs

extraOutputs

Konfiguracja opcjonalnego zestawu pomocniczych danych wyjściowych podczas wywołania ustaw te wartości przy użyciu context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Wartość właściwości

FunctionOutput[]

dziedziczone z Partial.extraOutputs

feedPollDelay

Czas (w milisekundach) dla opóźnienia między sondowaniem partycji pod kątem nowych zmian w kanale informacyjnym, po opróżnieniu wszystkich bieżących zmian. Wartość domyślna to 5000 milisekund lub 5 sekund.

feedPollDelay?: number

Wartość właściwości

number

dziedziczone zCosmosDBv3TriggerOptions.feedPollDelay

leaseAcquireInterval

Po ustawieniu definiuje, w milisekundach, interwał uruchamiania zadania obliczeniowego, jeśli partycje są równomiernie dystrybuowane między znane wystąpienia hosta. Wartość domyślna to 13000 (13 sekund).

leaseAcquireInterval?: number

Wartość właściwości

number

dziedziczone zCosmosDBv3TriggerOptions.leaseAcquireInterval

leaseCollectionName

Nazwa kolekcji do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, będzie ona używać "dzierżaw"

leaseCollectionName?: string

Wartość właściwości

string

dziedziczone zCosmosDBv3TriggerOptions.leaseCollectionName

leaseCollectionPrefix

Po ustawieniu wartość jest dodawana jako prefiks do dzierżaw utworzonych w kolekcji Dzierżawy dla tej funkcji. Użycie prefiksu umożliwia dwóm oddzielnym funkcjom usługi Azure Functions współużytkowania tej samej kolekcji dzierżaw przy użyciu różnych prefiksów.

leaseCollectionPrefix?: string

Wartość właściwości

string

dziedziczone zCosmosDBv3TriggerOptions.leaseCollectionPrefix

leaseCollectionThroughput

Gdy createLeaseCollectionIfNotExists jest ustawiona na true, definiuje liczbę jednostek żądań do przypisania do utworzonej kolekcji dzierżaw

leaseCollectionThroughput?: number

Wartość właściwości

number

dziedziczone zCosmosDBv3TriggerOptions.leaseCollectionThroughput

leaseConnectionStringSetting

Nazwa ustawienia aplikacji zawierającego parametry połączenia z usługą, która przechowuje kolekcję dzierżaw. Jeśli nie zostanie ustawiona, połączy się z usługą zdefiniowaną przez connectionStringSetting

leaseConnectionStringSetting?: string

Wartość właściwości

string

dziedziczone zCosmosDBv3TriggerOptions.leaseConnectionStringSetting

leaseDatabaseName

Nazwa bazy danych, która przechowuje kolekcję do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, zostanie użyta wartość databaseName

leaseDatabaseName?: string

Wartość właściwości

string

dziedziczone zCosmosDBv3TriggerOptions.leaseDatabaseName

leaseExpirationInterval

Po ustawieniu definiuje, w milisekundach, interwał, dla którego dzierżawa jest wykonywana w dzierżawie reprezentującej partycję. Jeśli dzierżawa nie zostanie odnowiona w tym interwale, spowoduje to wygaśnięcie, a własność partycji zostanie przeniesiona do innego wystąpienia. Wartość domyślna to 60000 (60 sekund).

leaseExpirationInterval?: number

Wartość właściwości

number

dziedziczone zCosmosDBv3TriggerOptions.leaseExpirationInterval

leaseRenewInterval

Po ustawieniu definiuje, w milisekundach, interwał odnawiania dla wszystkich dzierżaw dla partycji, które są obecnie przechowywane przez wystąpienie. Wartość domyślna to 17000 (17 sekund).

leaseRenewInterval?: number

Wartość właściwości

number

dziedziczone zCosmosDBv3TriggerOptions.leaseRenewInterval

maxItemsPerInvocation

Po ustawieniu ta właściwość ustawia maksymalną liczbę odebranych elementów na wywołanie funkcji. Jeśli operacje w monitorowanym kontenerze są wykonywane za pomocą procedur składowanych, zakres transakcji jest zachowywany podczas odczytywania elementów ze źródła zmian. W związku z tym liczba odebranych elementów może być większa niż określona wartość, aby elementy zmienione przez tę samą transakcję zostały zwrócone w ramach jednej partii niepodzielnej.

maxItemsPerInvocation?: number

Wartość właściwości

number

dziedziczone zCosmosDBv3TriggerOptions.maxItemsPerInvocation

preferredLocations

Definiuje preferowane lokalizacje (regiony) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB. Wartości powinny być rozdzielane przecinkami. Na przykład Wschodnie stany USA, Południowo-środkowe stany USA, Europa Północna

preferredLocations?: string

Wartość właściwości

string

dziedziczone zCosmosDBv3TriggerOptions.preferredLocations

return

Konfiguracja opcjonalnych podstawowych danych wyjściowych funkcji Jest to główne dane wyjściowe, które należy ustawić jako wartość zwracaną programu obsługi funkcji podczas wywołania

return?: FunctionOutput

Wartość właściwości

FunctionOutput

dziedziczone z Partial.return

startFromBeginning

Ta opcja nakazuje wyzwalaczowi odczytywanie zmian od początku historii zmian kontenera zamiast rozpoczynania się od bieżącej godziny. Odczyt od początku działa tylko przy pierwszym uruchomieniu wyzwalacza, tak jak w kolejnych uruchomieniach, punkty kontrolne są już przechowywane. Ustawienie tej opcji na wartość true, jeśli istnieją już utworzone dzierżawy, nie ma wpływu.

startFromBeginning?: boolean

Wartość właściwości

boolean

dziedziczone zCosmosDBv3TriggerOptions.startFromBeginning

useMultipleWriteLocations

Umożliwia zapisywanie kont w wielu regionach w kolekcji dzierżaw.

useMultipleWriteLocations?: boolean

Wartość właściwości

boolean

dziedziczone zCosmosDBv3TriggerOptions.useMultipleWriteLocations