CosmosDBv4FunctionOptions interface

Pakiet:

@azure/functions

Rozszerzenie

CosmosDBv4TriggerOptions,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

connection	Ustawienie aplikacji (lub zmienna środowiskowa) z parametrami połączenia usługi Cosmos DB
containerName	Nazwa monitorowanego kontenera
createLeaseContainerIfNotExists	Sprawdza istnienie i automatycznie tworzy kontener dzierżaw. Wartość domyślna to false
databaseName	Nazwa bazy danych usługi Azure Cosmos DB z monitorowanym kontenerem
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).
leaseConnection	Nazwa ustawienia aplikacji zawierającego parametry połączenia z usługą, która przechowuje kontener dzierżawy. Jeśli nie zostanie ustawiona, połączy się z usługą zdefiniowaną przez connection
leaseContainerName	Nazwa kontenera do przechowywania dzierżaw. Jeśli nie zostanie ustawiona, będzie ona używać "dzierżaw"
leaseContainerPrefix	Po ustawieniu wartość jest dodawana jako prefiks do dzierżaw utworzonych w kontenerze Dzierżawa dla tej funkcji. Użycie prefiksu umożliwia dwóm oddzielnym usłudze Azure Functions współużytkowania tego samego kontenera dzierżawy przy użyciu różnych prefiksów.
leaseDatabaseName	Nazwa bazy danych, która przechowuje kontener 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).
leasesContainerThroughput	Gdy createLeaseContainerIfNotExists jest ustawiona na true, definiuje liczbę jednostek żądań do przypisania do utworzonego kontenera dzierżawy
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.
startFromTime	Pobiera lub ustawia datę i godzinę, z której ma być inicjowana operacja odczytu zestawienia zmian. Zalecany format to ISO 8601 z projektantem UTC, takim jak 2021-02-16T14:19:29Z. Służy to tylko do ustawiania stanu początkowego wyzwalacza. Gdy wyzwalacz ma stan dzierżawy, zmiana tej wartości nie ma wpływu.

Szczegóły właściwości

handler

handler: CosmosDBv4Handler

Wartość właściwości

CosmosDBv4Handler

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

Wartość właściwości

CosmosDBv4Trigger

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

connection

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

connection: string

Wartość właściwości

string

dziedziczone zCosmosDBv4TriggerOptions.connection

containerName

Nazwa monitorowanego kontenera

containerName: string

Wartość właściwości

string

dziedziczone zCosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

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

createLeaseContainerIfNotExists?: boolean

Wartość właściwości

boolean

dziedziczone zCosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

Nazwa bazy danych usługi Azure Cosmos DB z monitorowanym kontenerem

databaseName: string

Wartość właściwości

string

dziedziczone zCosmosDBv4TriggerOptions.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 zCosmosDBv4TriggerOptions.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 zCosmosDBv4TriggerOptions.leaseAcquireInterval

leaseConnection

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

leaseConnection?: string

Wartość właściwości

string

dziedziczone zCosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

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

leaseContainerName?: string

Wartość właściwości

string

dziedziczone zCosmosDBv4TriggerOptions.leaseContainerName

leaseContainerPrefix

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

leaseContainerPrefix?: string

Wartość właściwości

string

dziedziczone zCosmosDBv4TriggerOptions.leaseContainerPrefix

leaseDatabaseName

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

leaseDatabaseName?: string

Wartość właściwości

string

dziedziczone zCosmosDBv4TriggerOptions.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 zCosmosDBv4TriggerOptions.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 zCosmosDBv4TriggerOptions.leaseRenewInterval

leasesContainerThroughput

Gdy createLeaseContainerIfNotExists jest ustawiona na true, definiuje liczbę jednostek żądań do przypisania do utworzonego kontenera dzierżawy

leasesContainerThroughput?: number

Wartość właściwości

number

dziedziczone zCosmosDBv4TriggerOptions.leasesContainerThroughput

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

startFromTime

Pobiera lub ustawia datę i godzinę, z której ma być inicjowana operacja odczytu zestawienia zmian. Zalecany format to ISO 8601 z projektantem UTC, takim jak 2021-02-16T14:19:29Z. Służy to tylko do ustawiania stanu początkowego wyzwalacza. Gdy wyzwalacz ma stan dzierżawy, zmiana tej wartości nie ma wpływu.

startFromTime?: string

Wartość właściwości

string

dziedziczone zCosmosDBv4TriggerOptions.startFromTime