你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CosmosDBOutput 接口

包:

com.microsoft.azure.functions.annotation

public interface CosmosDBOutput

CosmosDBOutput (name = “database”， databaseName = “ToDoList”， collectionName = “Items”， connectionStringSetting = “AzureCosmosDBConnection”) ) { return “{ \”id“： ”“ + System.currentTimeMillis () + ”“， ”description“： ”“ + message + ”“ }”; }

方法摘要

修饰符和类型	方法和描述
String	collectionName() 定义要写入的 CosmosDB 的集合名称。
int	collectionThroughput() 如果 CreateIfNotExists 为 true，则 定义所创建集合的吞吐量。
String	connectionStringSetting() 定义包含 CosmosDB 连接字符串的应用设置名称。
boolean	createIfNotExists() 定义要写入的 CosmosDB 的 ID。
String	databaseName() 定义要写入的 CosmosDB 的数据库名称。
String	dataType() 定义 Functions 运行时应如何处理参数值。 可能的值为： <li> <p>"" or string: treat it as a string whose value is serialized from the parameter </p> </li> <li> <p>binary: treat it as a binary data whose value comes from for example OutputBinding&lt;byte[]&gt; </p> </li>
String	name() function.json 中使用的变量名称。
String	partitionKey() 当 createIfNotExists 设置为 true 时，定义所创建集合的分区键路径。 可以包含绑定参数。
String	preferredLocations() 为 Azure Cosmos DB 服务中的异地复制数据库帐户定义首选位置 (区域) 。 值应以逗号分隔。 example， PreferredLocations = “美国东部，美国中南部，北欧”
boolean	useMultipleWriteLocations() 启用 以与多主帐户一起使用。

方法详细信息

collectionName

public String collectionName()

定义要写入的 CosmosDB 的集合名称。

Returns:

集合名称字符串。

collectionThroughput

public int collectionThroughput() default -1

如果 CreateIfNotExists 为 true，则 定义所创建集合的吞吐量。

Returns:

已创建集合的吞吐量。

connectionStringSetting

public String connectionStringSetting()

定义包含 CosmosDB 连接字符串的应用设置名称。

Returns:

连接字符串的应用设置名称。

createIfNotExists

public boolean createIfNotExists() default false

定义要写入的 CosmosDB 的 ID。

Returns:

ID 字符串。

databaseName

public String databaseName()

定义要写入的 CosmosDB 的数据库名称。

Returns:

数据库名称字符串。

dataType

public String dataType() default ""

定义 Functions 运行时应如何处理参数值。 可能的值为：

<li>

  <p>"" or string: treat it as a string whose value is serialized from the parameter </p>

</li>

<li>

  <p>binary: treat it as a binary data whose value comes from for example OutputBinding&lt;byte[]&gt; </p>

</li>

Returns:

将由 Functions 运行时使用的 dataType。

name

public String name()

function.json 中使用的变量名称。

Returns:

function.json 中使用的变量名称。

partitionKey

public String partitionKey() default ""

当 createIfNotExists 设置为 true 时，定义所创建集合的分区键路径。 可以包含绑定参数。

Returns:

已创建集合的 partitionKey。

preferredLocations

public String preferredLocations() default ""

为 Azure Cosmos DB 服务中的异地复制数据库帐户定义首选位置 (区域) 。 值应以逗号分隔。 example， PreferredLocations = “美国东部，美国中南部，北欧”

Returns:

异地复制数据库帐户的 PreferredLocations

useMultipleWriteLocations

public boolean useMultipleWriteLocations() default false

启用 以与多主帐户一起使用。

Returns:

是否使用多主帐户