CosmosDBv3InputOptions interface

Paquet:

@azure/functions

Propriétés

collectionName	Nom de la collection surveillée
connectionStringSetting	Paramètre d’application (ou variable d’environnement) avec la chaîne de connexion Cosmos DB
databaseName	Nom de la base de données Azure Cosmos DB avec la collection surveillée
id	ID du document à récupérer. Cette propriété prend en charge les expressions de liaison . Ne définissez pas les propriétés id et sqlQuery. Si vous ne définissez pas l’une ou l’autre, la collection entière est récupérée.
partitionKey	Spécifie la valeur de clé de partition pour la recherche. Peut inclure des paramètres de liaison. Il est nécessaire pour les recherches dans les collections partitionnés
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. Par exemple, USA Est,USA Centre Sud,Europe Nord
sqlQuery	Requête SQL Azure Cosmos DB utilisée pour récupérer plusieurs documents. La propriété prend en charge les liaisons d’exécution, comme dans cet exemple : SELECT * FROM c where c.departmentId = {departmentId} Ne définissez pas les propriétés id et sqlQuery. Si vous ne définissez pas l’une ou l’autre, la collection entière est récupérée.

Détails de la propriété

collectionName

Nom de la collection surveillée

collectionName: string

Valeur de propriété

string

connectionStringSetting

Paramètre d’application (ou variable d’environnement) avec la chaîne de connexion Cosmos DB

connectionStringSetting: string

Valeur de propriété

string

databaseName

Nom de la base de données Azure Cosmos DB avec la collection surveillée

databaseName: string

Valeur de propriété

string

id

ID du document à récupérer. Cette propriété prend en charge les expressions de liaison . Ne définissez pas les propriétés id et sqlQuery. Si vous ne définissez pas l’une ou l’autre, la collection entière est récupérée.

id?: string

Valeur de propriété

string

partitionKey

Spécifie la valeur de clé de partition pour la recherche. Peut inclure des paramètres de liaison. Il est nécessaire pour les recherches dans les collections partitionnés

partitionKey?: string

Valeur de propriété

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. Par exemple, USA Est,USA Centre Sud,Europe Nord

preferredLocations?: string

Valeur de propriété

string

sqlQuery

Requête SQL Azure Cosmos DB utilisée pour récupérer plusieurs documents. La propriété prend en charge les liaisons d’exécution, comme dans cet exemple : SELECT * FROM c where c.departmentId = {departmentId} Ne définissez pas les propriétés id et sqlQuery. Si vous ne définissez pas l’une ou l’autre, la collection entière est récupérée.

sqlQuery?: string

Valeur de propriété

string