CosmosDBv4InputOptions interface

Pacote:

@azure/functions

Propriedades

connection	Uma configuração de aplicativo (ou variável de ambiente) com a cadeia de conexão do Cosmos DB
containerName	O nome do contêiner que está sendo monitorado
databaseName	O nome do banco de dados do Azure Cosmos DB com o contêiner sendo monitorado
id	A ID do documento a ser recuperado. Esta propriedade suporta expressões de vinculação . Não defina as propriedades id e sqlQuery. Se você não definir nenhum deles, todo o contêiner será recuperado.
partitionKey	Especifica o valor da chave de partição para a pesquisa. Pode incluir parâmetros de vinculação. É necessário para pesquisas em contêineres particionados
preferredLocations	Define locais preferenciais (regiões) para contas de banco de dados replicadas geograficamente no serviço Azure Cosmos DB. Os valores devem ser separados por vírgula. Por exemplo, Leste dos EUA, Centro-Sul dos EUA, Norte da Europa
sqlQuery	Uma consulta SQL do Azure Cosmos DB usada para recuperar vários documentos. A propriedade suporta associações de tempo de execução, como neste exemplo: SELECT * FROM c where c.departmentId = {departmentId} Não defina as propriedades id e sqlQuery. Se você não definir nenhum deles, todo o contêiner será recuperado.

Detalhes de Propriedade

connection

Uma configuração de aplicativo (ou variável de ambiente) com a cadeia de conexão do Cosmos DB

connection: string

Valor de Propriedade

string

containerName

O nome do contêiner que está sendo monitorado

containerName: string

Valor de Propriedade

string

databaseName

O nome do banco de dados do Azure Cosmos DB com o contêiner sendo monitorado

databaseName: string

Valor de Propriedade

string

id

A ID do documento a ser recuperado. Esta propriedade suporta expressões de vinculação . Não defina as propriedades id e sqlQuery. Se você não definir nenhum deles, todo o contêiner será recuperado.

id?: string

Valor de Propriedade

string

partitionKey

Especifica o valor da chave de partição para a pesquisa. Pode incluir parâmetros de vinculação. É necessário para pesquisas em contêineres particionados

partitionKey?: string

Valor de Propriedade

string

preferredLocations

Define locais preferenciais (regiões) para contas de banco de dados replicadas geograficamente no serviço Azure Cosmos DB. Os valores devem ser separados por vírgula. Por exemplo, Leste dos EUA, Centro-Sul dos EUA, Norte da Europa

preferredLocations?: string

Valor de Propriedade

string

sqlQuery

Uma consulta SQL do Azure Cosmos DB usada para recuperar vários documentos. A propriedade suporta associações de tempo de execução, como neste exemplo: SELECT * FROM c where c.departmentId = {departmentId} Não defina as propriedades id e sqlQuery. Se você não definir nenhum deles, todo o contêiner será recuperado.

sqlQuery?: string

Valor de Propriedade

string