CosmosDBv4FunctionOptions interface

Paquet:

@azure/functions

Extends

CosmosDBv4TriggerOptions,Partial<FunctionOptions>

Propriétés

handler
retry	Une stratégie de nouvelle tentative facultative pour réexécuter une exécution ayant échoué jusqu’à ce que la réussite se produise ou que le nombre maximal de nouvelles tentatives soit atteint. En savoir plus ici
trigger

Propriétés héritées

connection	Paramètre d’application (ou variable d’environnement) avec la chaîne de connexion Cosmos DB
containerName	Nom du conteneur surveillé
createLeaseContainerIfNotExists	Vérifie l’existence et crée automatiquement le conteneur de baux. La valeur par défaut est false
databaseName	Nom de la base de données Azure Cosmos DB avec le conteneur surveillé
extraInputs	Configuration d’un ensemble facultatif d’entrées secondaires pendant l’appel, obtenez ces valeurs avec context.extraInputs.get()
extraOutputs	Configuration d’un ensemble facultatif de sorties secondaires pendant l’appel, définissez ces valeurs avec context.extraOutputs.set()
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).
leaseConnection	Nom d’un paramètre d’application qui contient la chaîne de connexion au service qui contient le conteneur de bail. S’il n’est pas défini, il se connecte au service défini par connection
leaseContainerName	Nom du conteneur à stocker les baux. S’il n’est pas défini, il utilise les « baux »
leaseContainerPrefix	Quand elle est définie, la valeur est ajoutée en tant que préfixe aux baux créés dans le conteneur Lease pour cette fonction. L’utilisation d’un préfixe permet à deux fonctions Azure distinctes de partager le même conteneur de baux à l’aide de préfixes différents.
leaseDatabaseName	Nom de la base de données qui contient le conteneur 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).
leasesContainerThroughput	Lorsque createLeaseContainerIfNotExists est défini sur true, définit la quantité d’unités de requête à affecter au conteneur de bail créé
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
return	Configuration de la sortie primaire facultative de la fonction Il s’agit de la sortie principale que vous devez définir comme valeur de retour du gestionnaire de fonctions pendant l’appel
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.
startFromTime	Obtient ou définit la date et l’heure à partir de laquelle initialiser l’opération de lecture du flux de modification. Le format recommandé est ISO 8601 avec l’indicateur UTC, tel que 2021-02-16T14:19:29Z. Il est utilisé uniquement pour définir l’état du déclencheur initial. Une fois que le déclencheur a un état de bail, la modification de cette valeur n’a aucun effet.

Détails de la propriété

handler

handler: CosmosDBv4Handler

Valeur de propriété

CosmosDBv4Handler

retry

Une stratégie de nouvelle tentative facultative pour réexécuter une exécution ayant échoué jusqu’à ce que la réussite se produise ou que le nombre maximal de nouvelles tentatives soit atteint. En savoir plus ici

retry?: RetryOptions

Valeur de propriété

RetryOptions

trigger

trigger?: CosmosDBv4Trigger

Valeur de propriété

CosmosDBv4Trigger

Détails de la propriété héritée

connection

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

connection: string

Valeur de propriété

string

héritée deCosmosDBv4TriggerOptions.connection

containerName

Nom du conteneur surveillé

containerName: string

Valeur de propriété

string

héritée deCosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

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

createLeaseContainerIfNotExists?: boolean

Valeur de propriété

boolean

héritée deCosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

Nom de la base de données Azure Cosmos DB avec le conteneur surveillé

databaseName: string

Valeur de propriété

string

héritée deCosmosDBv4TriggerOptions.databaseName

extraInputs

Configuration d’un ensemble facultatif d’entrées secondaires pendant l’appel, obtenez ces valeurs avec context.extraInputs.get()

extraInputs?: FunctionInput[]

Valeur de propriété

FunctionInput[]

héritée de Partial.extraInputs

extraOutputs

Configuration d’un ensemble facultatif de sorties secondaires pendant l’appel, définissez ces valeurs avec context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Valeur de propriété

FunctionOutput[]

héritée de Partial.extraOutputs

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

héritée deCosmosDBv4TriggerOptions.feedPollDelay

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

héritée deCosmosDBv4TriggerOptions.leaseAcquireInterval

leaseConnection

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

leaseConnection?: string

Valeur de propriété

string

héritée deCosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

Nom du conteneur à stocker les baux. S’il n’est pas défini, il utilise les « baux »

leaseContainerName?: string

Valeur de propriété

string

héritée deCosmosDBv4TriggerOptions.leaseContainerName

leaseContainerPrefix

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

leaseContainerPrefix?: string

Valeur de propriété

string

héritée deCosmosDBv4TriggerOptions.leaseContainerPrefix

leaseDatabaseName

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

leaseDatabaseName?: string

Valeur de propriété

string

héritée deCosmosDBv4TriggerOptions.leaseDatabaseName

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

héritée deCosmosDBv4TriggerOptions.leaseExpirationInterval

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

héritée deCosmosDBv4TriggerOptions.leaseRenewInterval

leasesContainerThroughput

Lorsque createLeaseContainerIfNotExists est défini sur true, définit la quantité d’unités de requête à affecter au conteneur de bail créé

leasesContainerThroughput?: number

Valeur de propriété

number

héritée deCosmosDBv4TriggerOptions.leasesContainerThroughput

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

héritée deCosmosDBv4TriggerOptions.maxItemsPerInvocation

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

héritée deCosmosDBv4TriggerOptions.preferredLocations

return

Configuration de la sortie primaire facultative de la fonction Il s’agit de la sortie principale que vous devez définir comme valeur de retour du gestionnaire de fonctions pendant l’appel

return?: FunctionOutput

Valeur de propriété

FunctionOutput

héritée de Partial.return

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

héritée deCosmosDBv4TriggerOptions.startFromBeginning

startFromTime

Obtient ou définit la date et l’heure à partir de laquelle initialiser l’opération de lecture du flux de modification. Le format recommandé est ISO 8601 avec l’indicateur UTC, tel que 2021-02-16T14:19:29Z. Il est utilisé uniquement pour définir l’état du déclencheur initial. Une fois que le déclencheur a un état de bail, la modification de cette valeur n’a aucun effet.

startFromTime?: string

Valeur de propriété

string

héritée deCosmosDBv4TriggerOptions.startFromTime