Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.microsoft.com/en-us/java/api/com.microsoft.azure.functions.annotation.cosmosdbinput below:

CosmosDBInput Interface | Microsoft Learn

Implements

java.lang.annotation.Annotation

public interface CosmosDBInput
implements java.lang.annotation.Annotation

Place this on a parameter whose value would come from CosmosDB. The parameter type can be one of the following:

• Some native Java types such as String
• Nullable values using Optional<T>
• Any POJO type

The following example shows a Java function that retrieves a single document. The function is triggered by an HTTP request that uses a query string to specify the ID to look up. That ID is used to retrieve a ToDoItem document from the specified database and collection. A sample URL would be like: http://localhost:7071/api/getItem?id=myid.

@FunctionName("getItem")
 public String cosmosDbQueryById(
    @HttpTrigger(name = "req",
                  methods = {HttpMethod.GET},
                  authLevel = AuthorizationLevel.ANONYMOUS) Optional<String> dummy,
    @CosmosDBInput(name = "database",
                      databaseName = "ToDoList",
                      collectionName = "Items",
                      id = "{Query.id}",
                      connectionStringSetting = "AzureCosmosDBConnection") Optional<String> item
 ) {
     return item.orElse("Not found");
 }

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

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

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

Defines how Functions runtime should treat the parameter value.

Defines the ID of the CosmosDB to which to bind.

The variable name used in function.json.

Defines partition key value for the lookup.

Defines the SQL query string to which to bind.

public abstract String collectionName()

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

Returns:

The collection name string.

public abstract String connectionStringSetting()

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

Returns:

The app setting name of the connection string.

public abstract String databaseName()

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

Returns:

The database name string.

public abstract String dataType()

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

• "": get the value as a string, and try to deserialize to actual parameter type like POJO
• string: always get the value as a string
• binary: get the value as a binary data, and try to deserialize to actual parameter type byte[]

Returns:

The dataType which will be used by the Functions runtime.

public abstract String id()

Defines the ID of the CosmosDB to which to bind.

Returns:

The ID string.

public abstract String name()

The variable name used in function.json.

Returns:

The variable name used in function.json.

public abstract String partitionKey()

Defines partition key value for the lookup. May include binding parameters.

Returns:

partition key value

public abstract String sqlQuery()

Defines the SQL query string to which to bind.

Returns:

The SQL query string.

Collaborate with us on GitHub

Was this page helpful?

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4