CosmosDBOutput Interface

Definition

CosmosDBOutput(name = "database", databaseName = "ToDoList", collectionName = "Items", connectionStringSetting = "AzureCosmosDBConnection") ) { return "{ \"id": "" + System.currentTimeMillis() + "", "description": "" + message + "" }"; }

public interface CosmosDBOutput

Methods

collectionName()

Defines the collection name of the CosmosDB to which to write.

collectionThroughput()

If CreateIfNotExists is true, defines the throughput of the created collection.

connectionStringSetting()

Defines the app setting name that contains the CosmosDB connection string.

createIfNotExists()

Defines the ID of the CosmosDB to which to write.

databaseName()

Defines the database name of the CosmosDB to which to write.

dataType()

Defines how Functions runtime should treat the parameter value. Possible values are:

  • "" or string: treat it as a string whose value is serialized from the parameter

  • binary: treat it as a binary data whose value comes from for example OutputBinding<byte[]>

name()

The variable name used in function.json.

partitionKey()

Defines the partition key path for the created collection when createIfNotExists is set to true. 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. example, PreferredLocations = "East US,South Central US,North Europe"

useMultipleWriteLocations()

Enable to use with Multi Master accounts.

Applies to