CosmosDBv4InputOptions interface

Пакет:

@azure/functions

Свойства

connection	Параметр приложения (или переменная среды) со строкой подключения Cosmos DB
containerName	Имя отслеживаемого контейнера
databaseName	Имя базы данных Azure Cosmos DB с отслеживаемой контейнером
id	Идентификатор извлекаемого документа. Это свойство поддерживает выражения привязки. Не устанавливайте свойства идентификатора и sqlQuery. Если вы не задаете один из них, извлекается весь контейнер.
partitionKey	Указывает значение ключа секции для подстановки. Может включать параметры привязки. Требуется для поиска в секционированных контейнерах
preferredLocations	Определяет предпочтительные расположения (регионы) для геореплицированных учетных записей базы данных в службе Azure Cosmos DB. Значения должны быть разделены запятыми. Например, восточная часть США, центрально-южная часть США, Северная Европа
sqlQuery	Sql-запрос Azure Cosmos DB, используемый для извлечения нескольких документов. Свойство поддерживает привязки среды выполнения, как в следующем примере: SELECT * FROM c where c.departmentId = {departmentId} Не устанавливайте идентификатор и свойства sqlQuery. Если вы не задаете один из них, извлекается весь контейнер.

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

connection

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

connection: string

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

string

containerName

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

containerName: string

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

string

databaseName

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

databaseName: string

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

string

id

Идентификатор извлекаемого документа. Это свойство поддерживает выражения привязки. Не устанавливайте свойства идентификатора и sqlQuery. Если вы не задаете один из них, извлекается весь контейнер.

id?: string

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

string

partitionKey

Указывает значение ключа секции для подстановки. Может включать параметры привязки. Требуется для поиска в секционированных контейнерах

partitionKey?: string

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

string

preferredLocations

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

preferredLocations?: string

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

string

sqlQuery

Sql-запрос Azure Cosmos DB, используемый для извлечения нескольких документов. Свойство поддерживает привязки среды выполнения, как в следующем примере: SELECT * FROM c where c.departmentId = {departmentId} Не устанавливайте идентификатор и свойства sqlQuery. Если вы не задаете один из них, извлекается весь контейнер.

sqlQuery?: string

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

string