CosmosDBv4TriggerOptions interface

Пакет:

@azure/functions

Свойства

connection	Параметр приложения (или переменная среды) со строкой подключения Cosmos DB
containerName	Имя отслеживаемого контейнера
createLeaseContainerIfNotExists	Проверяет наличие и автоматически создает контейнер аренды. Значение по умолчанию — false
databaseName	Имя базы данных Azure Cosmos DB с отслеживаемой контейнером
feedPollDelay	Время (в миллисекундах) задержки между опросом секции для новых изменений в канале после очистки всех текущих изменений. По умолчанию используется 5000 миллисекунд или 5 секунд.
leaseAcquireInterval	При задании определяется в миллисекундах интервал, который будет запускать задачу для вычисления, если секции распределяются равномерно между известными экземплярами узлов. Значение по умолчанию — 13000 (13 секунд).
leaseConnection	Имя параметра приложения, содержащего строку подключения к службе, в которой хранится контейнер аренды. Если он не установлен, он будет подключаться к службе, определенной connection
leaseContainerName	Имя контейнера для хранения аренд. Если этот параметр не задан, он будет использовать "аренды"
leaseContainerPrefix	При установке значение добавляется в виде префикса к арендам, созданным в контейнере аренды для этой функции. Использование префикса позволяет двум отдельным функциям Azure совместно использовать один контейнер аренды с помощью разных префиксов.
leaseDatabaseName	Имя базы данных, в которой хранится контейнер для хранения аренды. Если значение не задано, оно будет использовать значение databaseName
leaseExpirationInterval	Если задано, он определяет в миллисекундах интервал, для которого арендная плата берется на аренду, представляющую секцию. Если аренда не продлевается в течение этого интервала, срок ее действия истекает, а владение секцией перейдет в другой экземпляр. Значение по умолчанию — 60000 (60 секунд).
leaseRenewInterval	При установке определяется в миллисекундах интервал продления для всех аренд для секций, находящихся в данный момент экземпляром. Значение по умолчанию — 17000 (17 секунд).
leasesContainerThroughput	Если для createLeaseContainerIfNotExists задано значение true, определяется количество единиц запросов, назначаемых созданному контейнеру аренды.
maxItemsPerInvocation	При установке это свойство задает максимальное количество элементов, полученных на вызов функции. Если операции в отслеживаемом контейнере выполняются с помощью хранимых процедур, область транзакций сохраняется при чтении элементов из канала изменений. В результате число полученных элементов может быть выше указанного значения, чтобы элементы, измененные той же транзакцией, возвращались как часть одного атомарного пакета.
preferredLocations	Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например, восточная часть США, центрально-южная часть США, Северная Европа
startFromBeginning	Этот параметр указывает триггеру читать изменения с начала журнала изменений контейнера, а не начинаться с текущего времени. Чтение с самого начала работает только при первом запуске триггера, как и в последующих запусках, контрольные точки уже хранятся. Если уже созданные аренды уже созданы, этот параметр имеет значение true.
startFromTime	Возвращает или задает дату и время, из которого инициализировать операцию чтения канала изменений. Рекомендуемый формат — ISO 8601 с конструктором UTC, например 2021-02-16T14:19:29Z. Это используется только для задания начального состояния триггера. После того как триггер имеет состояние аренды, изменение этого значения не влияет.

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

connection

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

connection: string

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

string

containerName

Имя отслеживаемого контейнера

containerName: string

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

string

createLeaseContainerIfNotExists

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

createLeaseContainerIfNotExists?: boolean

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

boolean

databaseName

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

databaseName: string

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

string

feedPollDelay

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

feedPollDelay?: number

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

number

leaseAcquireInterval

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

leaseAcquireInterval?: number

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

number

leaseConnection

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

leaseConnection?: string

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

string

leaseContainerName

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

leaseContainerName?: string

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

string

leaseContainerPrefix

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

leaseContainerPrefix?: string

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

string

leaseDatabaseName

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

leaseDatabaseName?: string

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

string

leaseExpirationInterval

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

leaseExpirationInterval?: number

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

number

leaseRenewInterval

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

leaseRenewInterval?: number

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

number

leasesContainerThroughput

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

leasesContainerThroughput?: number

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

number

maxItemsPerInvocation

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

maxItemsPerInvocation?: number

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

number

preferredLocations

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

preferredLocations?: string

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

string

startFromBeginning

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

startFromBeginning?: boolean

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

boolean

startFromTime

Возвращает или задает дату и время, из которого инициализировать операцию чтения канала изменений. Рекомендуемый формат — ISO 8601 с конструктором UTC, например 2021-02-16T14:19:29Z. Это используется только для задания начального состояния триггера. После того как триггер имеет состояние аренды, изменение этого значения не влияет.

startFromTime?: string

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

string