Share via

CosmosDBv4InputOptions interface

  • Reference
Package:
@azure/functions

Properties

connection

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

The name of the container being monitored
databaseName

The name of the Azure Cosmos DB database with the container 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 container is retrieved.
partitionKey

Specifies the partition key value for the lookup. May include binding parameters. It is required for lookups in partitioned containers
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 container is retrieved.

Property Details

connection

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

connection: string

Property Value

string

containerName

The name of the container being monitored

containerName: string

Property Value

string

databaseName

The name of the Azure Cosmos DB database with the container 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 container 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 containers

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 container is retrieved.

sqlQuery?: string

Property Value

string