CosmosDBv4FunctionOptions interface

Пакет:

@azure/functions

Extends

CosmosDBv4TriggerOptions,Partial<FunctionOptions>

Свойства

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

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

connection	Параметр приложения (или переменная среды) со строкой подключения Cosmos DB
containerName	Имя отслеживаемого контейнера
createLeaseContainerIfNotExists	Проверяет наличие и автоматически создает контейнер аренды. Значение по умолчанию — false
databaseName	Имя базы данных Azure Cosmos DB с отслеживаемой контейнером
extraInputs	Настройка для дополнительного набора дополнительных входных данных во время вызова, получите эти значения с context.extraInputs.get()
extraOutputs	Настройка для дополнительного набора дополнительных выходных данных во время вызова задайте эти значения context.extraOutputs.set()
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. Значения должны быть разделены запятыми. Например, восточная часть США, центрально-южная часть США, Северная Европа
return	Настройка необязательных первичных выходных данных функции — это основной вывод, который необходимо задать в качестве возвращаемого значения обработчика функции во время вызова.
startFromBeginning	Этот параметр указывает триггеру читать изменения с начала журнала изменений контейнера, а не начинаться с текущего времени. Чтение с самого начала работает только при первом запуске триггера, как и в последующих запусках, контрольные точки уже хранятся. Если уже созданные аренды уже созданы, этот параметр имеет значение true.
startFromTime	Возвращает или задает дату и время, из которого инициализировать операцию чтения канала изменений. Рекомендуемый формат — ISO 8601 с конструктором UTC, например 2021-02-16T14:19:29Z. Это используется только для задания начального состояния триггера. После того как триггер имеет состояние аренды, изменение этого значения не влияет.

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

handler

handler: CosmosDBv4Handler

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

CosmosDBv4Handler

retry

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

retry?: RetryOptions

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

RetryOptions

trigger

trigger?: CosmosDBv4Trigger

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

CosmosDBv4Trigger

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

connection

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

connection: string

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

string

наследуется отCosmosDBv4TriggerOptions.connection

containerName

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

containerName: string

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

string

наследуется отCosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

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

createLeaseContainerIfNotExists?: boolean

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

boolean

наследуется отCosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

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

databaseName: string

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

string

наследуется отCosmosDBv4TriggerOptions.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

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

leaseAcquireInterval

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

leaseAcquireInterval?: number

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

number

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

leaseConnection

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

leaseConnection?: string

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

string

Унаследовано отCosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

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

leaseContainerName?: string

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

string

унаследован отCosmosDBv4TriggerOptions.leaseContainerName

leaseContainerPrefix

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

leaseContainerPrefix?: string

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

string

унаследовано отCosmosDBv4TriggerOptions.leaseContainerPrefix

leaseDatabaseName

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

leaseDatabaseName?: string

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

string

унаследован отCosmosDBv4TriggerOptions.leaseDatabaseName

leaseExpirationInterval

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

leaseExpirationInterval?: number

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

number

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

leaseRenewInterval

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

leaseRenewInterval?: number

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

number

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

leasesContainerThroughput

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

leasesContainerThroughput?: number

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

number

унаследован отCosmosDBv4TriggerOptions.leasesContainerThroughput

maxItemsPerInvocation

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

maxItemsPerInvocation?: number

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

number

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

preferredLocations

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

preferredLocations?: string

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

string

унаследовано отCosmosDBv4TriggerOptions.preferredLocations

return

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

return?: FunctionOutput

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

FunctionOutput

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

startFromBeginning

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

startFromBeginning?: boolean

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

boolean

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

startFromTime

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

startFromTime?: string

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

string

наследуется отCosmosDBv4TriggerOptions.startFromTime