CosmosDBv3TriggerOptions interface

Paquet:

@azure/functions

Propriétés

checkpointDocumentCount	Personnalise la quantité de documents entre les points de contrôle de bail. La valeur par défaut est postérieure à chaque appel de fonction.
checkpointInterval	Quand elle est définie, elle définit, en millisecondes, l’intervalle entre les points de contrôle de bail. La valeur par défaut est toujours après chaque appel de fonction.
collectionName	Nom de la collection surveillée
connectionStringSetting	Paramètre d’application (ou variable d’environnement) avec la chaîne de connexion Cosmos DB
createLeaseCollectionIfNotExists	Vérifie l’existence et crée automatiquement la collection de baux. La valeur par défaut est false
databaseName	Nom de la base de données Azure Cosmos DB avec la collection surveillée
feedPollDelay	Temps (en millisecondes) entre l’interrogation d’une partition pour les nouvelles modifications sur le flux, une fois que toutes les modifications actuelles sont vidées. La valeur par défaut est de 5 000 millisecondes ou de 5 secondes.
leaseAcquireInterval	Quand elle est définie, elle définit, en millisecondes, l’intervalle pour lancer une tâche pour calculer si les partitions sont distribuées uniformément entre les instances hôtes connues. La valeur par défaut est 13000 (13 secondes).
leaseCollectionName	Nom de la collection pour stocker les baux. S’il n’est pas défini, il utilise les « baux »
leaseCollectionPrefix	Quand elle est définie, la valeur est ajoutée en tant que préfixe aux baux créés dans la collection lease pour cette fonction. L’utilisation d’un préfixe permet à deux fonctions Azure distinctes de partager la même collection de baux à l’aide de préfixes différents.
leaseCollectionThroughput	Lorsque createLeaseCollectionIfNotExists est défini sur true, définit la quantité d’unités de requête à affecter à la collection de baux créée
leaseConnectionStringSetting	Nom d’un paramètre d’application qui contient la chaîne de connexion au service qui contient la collection de baux. S’il n’est pas défini, il se connecte au service défini par connectionStringSetting
leaseDatabaseName	Nom de la base de données qui contient la collection pour stocker les baux. S’il n’est pas défini, il utilise la valeur de databaseName
leaseExpirationInterval	Lorsqu’il est défini, il définit, en millisecondes, l’intervalle pour lequel le bail est pris sur un bail représentant une partition. Si le bail n’est pas renouvelé dans cet intervalle, il expire et la propriété de la partition passe à une autre instance. La valeur par défaut est 60000 (60 secondes).
leaseRenewInterval	Lorsqu’il est défini, il définit, en millisecondes, l’intervalle de renouvellement pour tous les baux pour les partitions actuellement détenues par une instance. La valeur par défaut est 17000 (17 secondes).
maxItemsPerInvocation	Quand elle est définie, cette propriété définit le nombre maximal d’éléments reçus par appel de fonction. Si des opérations dans le conteneur surveillé sont effectuées via des procédures stockées, l’étendue de transaction est conservée lors de la lecture d’éléments à partir du flux de modification. Par conséquent, le nombre d’éléments reçus peut être supérieur à la valeur spécifiée afin que les éléments modifiés par la même transaction soient retournés dans le cadre d’un lot atomique.
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
startFromBeginning	Cette option indique au déclencheur de lire les modifications à partir du début de l’historique des modifications du conteneur au lieu de commencer à l’heure actuelle. La lecture à partir du début fonctionne uniquement la première fois que le déclencheur démarre, comme dans les exécutions suivantes, les points de contrôle sont déjà stockés. La définition de cette option sur true lorsqu’il existe déjà des baux créés n’a aucun effet.
useMultipleWriteLocations	Permet aux comptes multirégions d’écrire dans la collection de baux.

Détails de la propriété

checkpointDocumentCount

Personnalise la quantité de documents entre les points de contrôle de bail. La valeur par défaut est postérieure à chaque appel de fonction.

checkpointDocumentCount?: number

Valeur de propriété

number

checkpointInterval

Quand elle est définie, elle définit, en millisecondes, l’intervalle entre les points de contrôle de bail. La valeur par défaut est toujours après chaque appel de fonction.

checkpointInterval?: number

Valeur de propriété

number

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

createLeaseCollectionIfNotExists

Vérifie l’existence et crée automatiquement la collection de baux. La valeur par défaut est false

createLeaseCollectionIfNotExists?: boolean

Valeur de propriété

boolean

databaseName

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

databaseName: string

Valeur de propriété

string

feedPollDelay

Temps (en millisecondes) entre l’interrogation d’une partition pour les nouvelles modifications sur le flux, une fois que toutes les modifications actuelles sont vidées. La valeur par défaut est de 5 000 millisecondes ou de 5 secondes.

feedPollDelay?: number

Valeur de propriété

number

leaseAcquireInterval

Quand elle est définie, elle définit, en millisecondes, l’intervalle pour lancer une tâche pour calculer si les partitions sont distribuées uniformément entre les instances hôtes connues. La valeur par défaut est 13000 (13 secondes).

leaseAcquireInterval?: number

Valeur de propriété

number

leaseCollectionName

Nom de la collection pour stocker les baux. S’il n’est pas défini, il utilise les « baux »

leaseCollectionName?: string

Valeur de propriété

string

leaseCollectionPrefix

Quand elle est définie, la valeur est ajoutée en tant que préfixe aux baux créés dans la collection lease pour cette fonction. L’utilisation d’un préfixe permet à deux fonctions Azure distinctes de partager la même collection de baux à l’aide de préfixes différents.

leaseCollectionPrefix?: string

Valeur de propriété

string

leaseCollectionThroughput

Lorsque createLeaseCollectionIfNotExists est défini sur true, définit la quantité d’unités de requête à affecter à la collection de baux créée

leaseCollectionThroughput?: number

Valeur de propriété

number

leaseConnectionStringSetting

Nom d’un paramètre d’application qui contient la chaîne de connexion au service qui contient la collection de baux. S’il n’est pas défini, il se connecte au service défini par connectionStringSetting

leaseConnectionStringSetting?: string

Valeur de propriété

string

leaseDatabaseName

Nom de la base de données qui contient la collection pour stocker les baux. S’il n’est pas défini, il utilise la valeur de databaseName

leaseDatabaseName?: string

Valeur de propriété

string

leaseExpirationInterval

Lorsqu’il est défini, il définit, en millisecondes, l’intervalle pour lequel le bail est pris sur un bail représentant une partition. Si le bail n’est pas renouvelé dans cet intervalle, il expire et la propriété de la partition passe à une autre instance. La valeur par défaut est 60000 (60 secondes).

leaseExpirationInterval?: number

Valeur de propriété

number

leaseRenewInterval

Lorsqu’il est défini, il définit, en millisecondes, l’intervalle de renouvellement pour tous les baux pour les partitions actuellement détenues par une instance. La valeur par défaut est 17000 (17 secondes).

leaseRenewInterval?: number

Valeur de propriété

number

maxItemsPerInvocation

Quand elle est définie, cette propriété définit le nombre maximal d’éléments reçus par appel de fonction. Si des opérations dans le conteneur surveillé sont effectuées via des procédures stockées, l’étendue de transaction est conservée lors de la lecture d’éléments à partir du flux de modification. Par conséquent, le nombre d’éléments reçus peut être supérieur à la valeur spécifiée afin que les éléments modifiés par la même transaction soient retournés dans le cadre d’un lot atomique.

maxItemsPerInvocation?: number

Valeur de propriété

number

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

startFromBeginning

Cette option indique au déclencheur de lire les modifications à partir du début de l’historique des modifications du conteneur au lieu de commencer à l’heure actuelle. La lecture à partir du début fonctionne uniquement la première fois que le déclencheur démarre, comme dans les exécutions suivantes, les points de contrôle sont déjà stockés. La définition de cette option sur true lorsqu’il existe déjà des baux créés n’a aucun effet.

startFromBeginning?: boolean

Valeur de propriété

boolean

useMultipleWriteLocations

Permet aux comptes multirégions d’écrire dans la collection de baux.

useMultipleWriteLocations?: boolean

Valeur de propriété

boolean