CosmosDBOutput Interface

Paquet:

com.microsoft.azure.functions.annotation

public interface CosmosDBOutput

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

Résumé de la méthode

Modificateur et type	Méthode et description
String	collectionName() Définit le nom de la collection cosmosDB dans laquelle écrire.
int	collectionThroughput() Si CreateIfNotExists a la valeur true, définit le débit de la collection créée.
String	connectionStringSetting() Définit le nom du paramètre d’application qui contient la chaîne de connexion CosmosDB.
boolean	createIfNotExists() Définit l’ID de la base de données CosmosDB dans laquelle écrire.
String	databaseName() Définit le nom de la base de données cosmosDB dans laquelle écrire.
String	dataType() Définit comment le runtime Functions doit traiter la valeur de paramètre. Les valeurs possibles sont les suivantes : <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() Nom de variable utilisé dans function.json.
String	partitionKey() Définit le chemin de la clé de partition pour la collection créée lorsque createIfNotExists a la valeur true. Peut inclure des paramètres de liaison.
String	preferredLocations() Définit les emplacements préférés (régions) pour les comptes de base de données géorépliqués dans le service Azure Cosmos DB. Les valeurs doivent être séparées par des virgules. exemple, PreferredLocations = « USA Est,USA Centre Sud,Europe Nord »
boolean	useMultipleWriteLocations() Activer l’utilisation avec les comptes multimaître.

Détails de la méthode

collectionName

public String collectionName()

Définit le nom de la collection cosmosDB dans laquelle écrire.

Retours:

Chaîne de nom de collection.

collectionThroughput

public int collectionThroughput() default -1

Si CreateIfNotExists a la valeur true, définit le débit de la collection créée.

Retours:

Débit de la collection créée.

connectionStringSetting

public String connectionStringSetting()

Définit le nom du paramètre d’application qui contient la chaîne de connexion CosmosDB.

Retours:

Nom du paramètre d’application de la chaîne de connexion.

createIfNotExists

public boolean createIfNotExists() default false

Définit l’ID de la base de données CosmosDB dans laquelle écrire.

Retours:

ID de la chaîne.

databaseName

public String databaseName()

Définit le nom de la base de données cosmosDB dans laquelle écrire.

Retours:

Chaîne de nom de base de données.

dataType

public String dataType() default ""

Définit comment le runtime Functions doit traiter la valeur de paramètre. Les valeurs possibles sont les suivantes :

<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>

Retours:

DataType qui sera utilisé par le runtime Functions.

name

public String name()

Nom de variable utilisé dans function.json.

Retours:

Nom de variable utilisé dans function.json.

partitionKey

public String partitionKey() default ""

Définit le chemin de la clé de partition pour la collection créée lorsque createIfNotExists a la valeur true. Peut inclure des paramètres de liaison.

Retours:

partitionKey de la collection créée.

preferredLocations

public String preferredLocations() default ""

Définit les emplacements préférés (régions) pour les comptes de base de données géorépliqués dans le service Azure Cosmos DB. Les valeurs doivent être séparées par des virgules. exemple, PreferredLocations = « USA Est,USA Centre Sud,Europe Nord »

Retours:

PreferredLocations pour les comptes de base de données géorépliqués

useMultipleWriteLocations

public boolean useMultipleWriteLocations() default false

Activer l’utilisation avec les comptes multimaître.

Retours:

s’il s’il s’agisse de comptes multimaître