CosmosDBv3OutputOptions interface

Package:

@azure/functions

Properties

collectionName	The name of the collection being monitored
collectionThroughput	When createIfNotExists is true, it defines the throughput of the created collection
connectionStringSetting	An app setting (or environment variable) with the Cosmos DB connection string
createIfNotExists	A boolean value to indicate whether the collection is created when it doesn't exist. The default is false because new collections are created with reserved throughput, which has cost implications. For more information, see the pricing page.
databaseName	The name of the Azure Cosmos DB database with the collection being monitored
partitionKey	When createIfNotExists is true, it defines the partition key path for the created collection. May include binding parameters.
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
useMultipleWriteLocations	When set to true along with preferredLocations, supports multi-region writes in the Azure Cosmos DB service.

Property Details

collectionName

The name of the collection being monitored

collectionName: string

Property Value

string

collectionThroughput

When createIfNotExists is true, it defines the throughput of the created collection

collectionThroughput?: number

Property Value

number

connectionStringSetting

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

connectionStringSetting: string

Property Value

string

createIfNotExists

A boolean value to indicate whether the collection is created when it doesn't exist. The default is false because new collections are created with reserved throughput, which has cost implications. For more information, see the pricing page.

createIfNotExists?: boolean

Property Value

boolean

databaseName

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

databaseName: string

Property Value

string

partitionKey

When createIfNotExists is true, it defines the partition key path for the created collection. May include binding parameters.

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

useMultipleWriteLocations

When set to true along with preferredLocations, supports multi-region writes in the Azure Cosmos DB service.

useMultipleWriteLocations?: boolean

Property Value

boolean