CosmosDBv3InputOptions interface

Package:

@azure/functions

Properties

collectionName	The name of the collection being monitored
connectionStringSetting	An app setting (or environment variable) with the Cosmos DB connection string
databaseName	The name of the Azure Cosmos DB database with the collection being monitored
id	The ID of the document to retrieve. This property supports binding expressions. Don't set both the id and sqlQuery properties. If you don't set either one, the entire collection is retrieved.
partitionKey	Specifies the partition key value for the lookup. May include binding parameters. It is required for lookups in partitioned collections
preferredLocations	Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. For example, East US,South Central US,North Europe
sqlQuery	An Azure Cosmos DB SQL query used for retrieving multiple documents. The property supports runtime bindings, as in this example: SELECT * FROM c where c.departmentId = {departmentId} Don't set both the id and sqlQuery properties. If you don't set either one, the entire collection is retrieved.

Property Details

collectionName

The name of the collection being monitored

collectionName: string

Property Value

string

connectionStringSetting

An app setting (or environment variable) with the Cosmos DB connection string

connectionStringSetting: string

Property Value

string

databaseName

The name of the Azure Cosmos DB database with the collection being monitored

databaseName: string

Property Value

string

id

The ID of the document to retrieve. This property supports binding expressions. Don't set both the id and sqlQuery properties. If you don't set either one, the entire collection is retrieved.

id?: string

Property Value

string

partitionKey

Specifies the partition key value for the lookup. May include binding parameters. It is required for lookups in partitioned collections

partitionKey?: string

Property Value

string

preferredLocations

Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. For example, East US,South Central US,North Europe

preferredLocations?: string

Property Value

string

sqlQuery

An Azure Cosmos DB SQL query used for retrieving multiple documents. The property supports runtime bindings, as in this example: SELECT * FROM c where c.departmentId = {departmentId} Don't set both the id and sqlQuery properties. If you don't set either one, the entire collection is retrieved.

sqlQuery?: string

Property Value

string