com.microsoft.azure.functions.annotation

Annotation Type CosmosDBOutput

@Retention(value=RUNTIME)
 @Target(value={PARAMETER,METHOD})
public @interface CosmosDBOutput

Place this on a parameter whose value would be written to CosmosDB. The parameter type should be OutputBinding<T>, where T could be one of:

• Some native Java types such as String
• Any POJO type

The following example shows a Java function that adds a document to a database, using data provided in the body of an HTTP Post request.

  @FunctionName("addItem")

 public String cosmosDbAddItem(
     @HttpTrigger(name = "request", methods = {HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS)
     final String message,
     @CosmosDBOutput(name = "database", databaseName = "ToDoList", collectionName = "Items", 
    connectionStringSetting = "AzureCosmosDBConnection")
 ) {
     return "{ \"id\": \"" + System.currentTimeMillis() + "\", \"description\": \"" + message + "\" }";
 }
 

Since:

1.0.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	collectionName Defines the collection name of the CosmosDB to which to write.
String	connectionStringSetting Defines the app setting name that contains the CosmosDB connection string.
String	databaseName Defines the database name of the CosmosDB to which to write.
String	name The variable name used in function.json.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	collectionThroughput If CreateIfNotExists is true, defines the throughput of the created collection.
boolean	createIfNotExists Defines the ID of the CosmosDB to which to write.
String	dataType Defines how Functions runtime should treat the parameter value.
String	partitionKey Defines the partition key path for the created collection when createIfNotExists is set to true.
String	preferredLocations Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service.
boolean	useMultipleWriteLocations Enable to use with Multi Master accounts.

Element Detail

name

public abstract String name

The variable name used in function.json.

Returns:

The variable name used in function.json.

databaseName

public abstract String databaseName

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

Returns:

The database name string.

collectionName

public abstract String collectionName

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

Returns:

The collection name string.

connectionStringSetting

public abstract String connectionStringSetting

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

Returns:

The app setting name of the connection string.

dataType

public abstract String 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[]>

Returns:

The dataType which will be used by the Functions runtime.

Default:

""

createIfNotExists

public abstract boolean createIfNotExists

Defines the ID of the CosmosDB to which to write.

Returns:

The ID string.

Default:

false

partitionKey

public abstract String partitionKey

Defines the partition key path for the created collection when createIfNotExists is set to true. May include binding parameters.

Returns:

partitionKey of the created collection.

Default:

""

collectionThroughput

public abstract int collectionThroughput

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

Returns:

Throughput of the created collection.

Default:

-1

useMultipleWriteLocations

public abstract boolean useMultipleWriteLocations

Enable to use with Multi Master accounts.

Returns:

whether to Multi Master accounts

Default:

false

preferredLocations

public abstract String 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"

Returns:

PreferredLocations for geo-replicated database accounts

Default:

""