CosmosDBv3FunctionOptions interface

Пакет:

@azure/functions

Extends

CosmosDBv3TriggerOptions,Partial<FunctionOptions>

Свойства

handler
retry	Необязательная политика повторных попыток для повторного запуска неудачного выполнения до тех пор, пока не будет выполнено успешное завершение или максимальное количество повторных попыток. Дополнительные здесь
trigger

Унаследованные свойства

checkpointDocumentCount	Настраивает объем документов между контрольными точками аренды. Значение по умолчанию выполняется после каждого вызова функции.
checkpointInterval	При установке определяется в миллисекундах интервал между контрольными точками аренды. Значение по умолчанию всегда выполняется после каждого вызова функции.
collectionName	Имя отслеживаемой коллекции
connectionStringSetting	Параметр приложения (или переменная среды) со строкой подключения Cosmos DB
createLeaseCollectionIfNotExists	Проверяет наличие и автоматически создает коллекцию аренд. Значение по умолчанию — false
databaseName	Имя базы данных Azure Cosmos DB с отслеживаемой коллекцией
extraInputs	Настройка для дополнительного набора дополнительных входных данных во время вызова, получите эти значения с context.extraInputs.get()
extraOutputs	Настройка для дополнительного набора дополнительных выходных данных во время вызова задайте эти значения context.extraOutputs.set()
feedPollDelay	Время (в миллисекундах) задержки между опросом секции для новых изменений в канале после очистки всех текущих изменений. По умолчанию используется 5000 миллисекунд или 5 секунд.
leaseAcquireInterval	При задании определяется в миллисекундах интервал, который будет запускать задачу для вычисления, если секции распределяются равномерно между известными экземплярами узлов. Значение по умолчанию — 13000 (13 секунд).
leaseCollectionName	Имя коллекции для хранения аренд. Если этот параметр не задан, он будет использовать "аренды"
leaseCollectionPrefix	При установке значение добавляется в виде префикса к арендам, созданным в коллекции аренд для этой функции. Использование префикса позволяет двум отдельным функциям Azure совместно использовать одну коллекцию аренды с помощью разных префиксов.
leaseCollectionThroughput	Если createLeaseCollectionIfNotExists задано значение true, определяет количество единиц запросов, назначаемых созданной коллекции аренды.
leaseConnectionStringSetting	Имя параметра приложения, содержащего строку подключения к службе, которая содержит коллекцию аренды. Если он не установлен, он будет подключаться к службе, определенной connectionStringSetting
leaseDatabaseName	Имя базы данных, в которой хранится коллекция для хранения аренд. Если значение не задано, оно будет использовать значение databaseName
leaseExpirationInterval	Если задано, он определяет в миллисекундах интервал, для которого арендная плата берется на аренду, представляющую секцию. Если аренда не продлевается в течение этого интервала, срок ее действия истекает, а владение секцией перейдет в другой экземпляр. Значение по умолчанию — 60000 (60 секунд).
leaseRenewInterval	При установке определяется в миллисекундах интервал продления для всех аренд для секций, находящихся в данный момент экземпляром. Значение по умолчанию — 17000 (17 секунд).
maxItemsPerInvocation	При установке это свойство задает максимальное количество элементов, полученных на вызов функции. Если операции в отслеживаемом контейнере выполняются с помощью хранимых процедур, область транзакций сохраняется при чтении элементов из канала изменений. В результате число полученных элементов может быть выше указанного значения, чтобы элементы, измененные той же транзакцией, возвращались как часть одного атомарного пакета.
preferredLocations	Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например, восточная часть США, центрально-южная часть США, Северная Европа
return	Настройка необязательных первичных выходных данных функции — это основной вывод, который необходимо задать в качестве возвращаемого значения обработчика функции во время вызова.
startFromBeginning	Этот параметр указывает триггеру читать изменения с начала журнала изменений контейнера, а не начинаться с текущего времени. Чтение с самого начала работает только при первом запуске триггера, как и в последующих запусках, контрольные точки уже хранятся. Если уже созданные аренды уже созданы, этот параметр имеет значение true.
useMultipleWriteLocations	Включает учетные записи с несколькими регионами для записи в коллекцию аренд.

Сведения о свойстве

handler

handler: CosmosDBv3Handler

Значение свойства

CosmosDBv3Handler

retry

Необязательная политика повторных попыток для повторного запуска неудачного выполнения до тех пор, пока не будет выполнено успешное завершение или максимальное количество повторных попыток. Дополнительные здесь

retry?: RetryOptions

Значение свойства

RetryOptions

trigger

trigger?: CosmosDBv3Trigger

Значение свойства

CosmosDBv3Trigger

Сведения об унаследованном свойстве

checkpointDocumentCount

Настраивает объем документов между контрольными точками аренды. Значение по умолчанию выполняется после каждого вызова функции.

checkpointDocumentCount?: number

Значение свойства

number

унаследован отCosmosDBv3TriggerOptions.checkpointDocumentCount

checkpointInterval

При установке определяется в миллисекундах интервал между контрольными точками аренды. Значение по умолчанию всегда выполняется после каждого вызова функции.

checkpointInterval?: number

Значение свойства

number

унаследовано отCosmosDBv3TriggerOptions.checkpointInterval

collectionName

Имя отслеживаемой коллекции

collectionName: string

Значение свойства

string

Наследуется отCosmosDBv3TriggerOptions.collectionName

connectionStringSetting

Параметр приложения (или переменная среды) со строкой подключения Cosmos DB

connectionStringSetting: string

Значение свойства

string

унаследован отCosmosDBv3TriggerOptions.connectionStringSetting

createLeaseCollectionIfNotExists

Проверяет наличие и автоматически создает коллекцию аренд. Значение по умолчанию — false

createLeaseCollectionIfNotExists?: boolean

Значение свойства

boolean

унаследован отCosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

databaseName

Имя базы данных Azure Cosmos DB с отслеживаемой коллекцией

databaseName: string

Значение свойства

string

наследуется отCosmosDBv3TriggerOptions.databaseName

extraInputs

Настройка для дополнительного набора дополнительных входных данных во время вызова, получите эти значения с context.extraInputs.get()

extraInputs?: FunctionInput[]

Значение свойства

FunctionInput[]

унаследовано от partial.extraInputs

extraOutputs

Настройка для дополнительного набора дополнительных выходных данных во время вызова задайте эти значения context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Значение свойства

FunctionOutput[]

унаследован от partial.extraOutputs

feedPollDelay

Время (в миллисекундах) задержки между опросом секции для новых изменений в канале после очистки всех текущих изменений. По умолчанию используется 5000 миллисекунд или 5 секунд.

feedPollDelay?: number

Значение свойства

number

унаследован отCosmosDBv3TriggerOptions.feedPollDelay

leaseAcquireInterval

При задании определяется в миллисекундах интервал, который будет запускать задачу для вычисления, если секции распределяются равномерно между известными экземплярами узлов. Значение по умолчанию — 13000 (13 секунд).

leaseAcquireInterval?: number

Значение свойства

number

унаследован отCosmosDBv3TriggerOptions.leaseAcquireInterval

leaseCollectionName

Имя коллекции для хранения аренд. Если этот параметр не задан, он будет использовать "аренды"

leaseCollectionName?: string

Значение свойства

string

Унаследовано отCosmosDBv3TriggerOptions.leaseCollectionName

leaseCollectionPrefix

При установке значение добавляется в виде префикса к арендам, созданным в коллекции аренд для этой функции. Использование префикса позволяет двум отдельным функциям Azure совместно использовать одну коллекцию аренды с помощью разных префиксов.

leaseCollectionPrefix?: string

Значение свойства

string

унаследован отCosmosDBv3TriggerOptions.leaseCollectionPrefix

leaseCollectionThroughput

Если createLeaseCollectionIfNotExists задано значение true, определяет количество единиц запросов, назначаемых созданной коллекции аренды.

leaseCollectionThroughput?: number

Значение свойства

number

унаследован отCosmosDBv3TriggerOptions.leaseCollectionThroughput

leaseConnectionStringSetting

Имя параметра приложения, содержащего строку подключения к службе, которая содержит коллекцию аренды. Если он не установлен, он будет подключаться к службе, определенной connectionStringSetting

leaseConnectionStringSetting?: string

Значение свойства

string

наследуется отCosmosDBv3TriggerOptions.leaseConnectionStringSetting

leaseDatabaseName

Имя базы данных, в которой хранится коллекция для хранения аренд. Если значение не задано, оно будет использовать значение databaseName

leaseDatabaseName?: string

Значение свойства

string

наследуется отCosmosDBv3TriggerOptions.leaseDatabaseName

leaseExpirationInterval

Если задано, он определяет в миллисекундах интервал, для которого арендная плата берется на аренду, представляющую секцию. Если аренда не продлевается в течение этого интервала, срок ее действия истекает, а владение секцией перейдет в другой экземпляр. Значение по умолчанию — 60000 (60 секунд).

leaseExpirationInterval?: number

Значение свойства

number

унаследовано отCosmosDBv3TriggerOptions.leaseExpirationInterval

leaseRenewInterval

При установке определяется в миллисекундах интервал продления для всех аренд для секций, находящихся в данный момент экземпляром. Значение по умолчанию — 17000 (17 секунд).

leaseRenewInterval?: number

Значение свойства

number

унаследован отCosmosDBv3TriggerOptions.leaseRenewInterval

maxItemsPerInvocation

При установке это свойство задает максимальное количество элементов, полученных на вызов функции. Если операции в отслеживаемом контейнере выполняются с помощью хранимых процедур, область транзакций сохраняется при чтении элементов из канала изменений. В результате число полученных элементов может быть выше указанного значения, чтобы элементы, измененные той же транзакцией, возвращались как часть одного атомарного пакета.

maxItemsPerInvocation?: number

Значение свойства

number

Унаследовано отCosmosDBv3TriggerOptions.maxItemsPerInvocation

preferredLocations

Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например, восточная часть США, центрально-южная часть США, Северная Европа

preferredLocations?: string

Значение свойства

string

наследуется отCosmosDBv3TriggerOptions.preferredLocations

return

Настройка необязательных первичных выходных данных функции — это основной вывод, который необходимо задать в качестве возвращаемого значения обработчика функции во время вызова.

return?: FunctionOutput

Значение свойства

FunctionOutput

наследуется от partial.return

startFromBeginning

Этот параметр указывает триггеру читать изменения с начала журнала изменений контейнера, а не начинаться с текущего времени. Чтение с самого начала работает только при первом запуске триггера, как и в последующих запусках, контрольные точки уже хранятся. Если уже созданные аренды уже созданы, этот параметр имеет значение true.

startFromBeginning?: boolean

Значение свойства

boolean

унаследован отCosmosDBv3TriggerOptions.startFromBeginning

useMultipleWriteLocations

Включает учетные записи с несколькими регионами для записи в коллекцию аренд.

useMultipleWriteLocations?: boolean

Значение свойства

boolean

наследуется отCosmosDBv3TriggerOptions.useMultipleWriteLocations