CosmosDBv3FunctionOptions interface

Paquete:

@azure/functions

Extends

CosmosDBv3TriggerOptions,Partial<FunctionOptions>

Propiedades

handler
retry	Una directiva de reintento opcional para volver a ejecutar una ejecución con errores hasta que se produzca correctamente la finalización o se alcance el número máximo de reintentos. Obtenga más información aquí
trigger

Propiedades heredadas

checkpointDocumentCount	Personaliza la cantidad de documentos entre puntos de control de concesión. El valor predeterminado es después de cada llamada de función.
checkpointInterval	Cuando se establece, define, en milisegundos, el intervalo entre los puntos de control de concesión. El valor predeterminado siempre es después de cada llamada de función.
collectionName	Nombre de la colección que se está supervisando
connectionStringSetting	Una configuración de aplicación (o variable de entorno) con la cadena de conexión de Cosmos DB
createLeaseCollectionIfNotExists	Comprueba si existe y crea automáticamente la colección de concesiones. El valor predeterminado es false
databaseName	Nombre de la base de datos de Azure Cosmos DB con la colección que se está supervisando
extraInputs	Configuración de un conjunto opcional de entradas secundarias Durante la invocación, obtenga estos valores con context.extraInputs.get()
extraOutputs	Configuración de un conjunto opcional de salidas secundarias Durante la invocación, establezca estos valores con context.extraOutputs.set()
feedPollDelay	Tiempo (en milisegundos) para el retraso entre sondear una partición para los nuevos cambios en la fuente, después de que se agoten todos los cambios actuales. El valor predeterminado es de 5000 milisegundos o 5 segundos.
leaseAcquireInterval	Cuando se establece, define, en milisegundos, el intervalo para iniciar una tarea para calcular si las particiones se distribuyen uniformemente entre instancias de host conocidas. El valor predeterminado es 13000 (13 segundos).
leaseCollectionName	Nombre de la colección que se va a almacenar concesiones. Si no se establece, usará "concesiones"
leaseCollectionPrefix	Cuando se establece, el valor se agrega como prefijo a las concesiones creadas en la colección Lease para esta función. El uso de un prefijo permite que dos funciones independientes de Azure Functions compartan la misma colección de concesiones mediante prefijos diferentes.
leaseCollectionThroughput	Cuando createLeaseCollectionIfNotExists se establece en true, define la cantidad de unidades de solicitud que se asignarán a la colección de concesiones creada.
leaseConnectionStringSetting	Nombre de una configuración de aplicación que contiene la cadena de conexión al servicio que contiene la colección de concesiones. Si no se establece, se conectará al servicio definido por connectionStringSetting
leaseDatabaseName	Nombre de la base de datos que contiene la colección para almacenar concesiones. Si no se establece, usará el valor de databaseName
leaseExpirationInterval	Cuando se establece, define, en milisegundos, el intervalo para el que se toma la concesión en una concesión que representa una partición. Si la concesión no se renueva dentro de este intervalo, hará que expire y la propiedad de la partición se moverá a otra instancia. El valor predeterminado es 60000 (60 segundos).
leaseRenewInterval	Cuando se establece, define, en milisegundos, el intervalo de renovación de todas las concesiones para las particiones que mantiene actualmente una instancia. El valor predeterminado es 17000 (17 segundos).
maxItemsPerInvocation	Cuando se establece, esta propiedad establece el número máximo de elementos recibidos por llamada de función. Si las operaciones del contenedor supervisado se realizan mediante procedimientos almacenados, el ámbito de transacción se conserva al leer elementos de la fuente de cambios. Como resultado, el número de elementos recibidos podría ser mayor que el valor especificado para que los elementos modificados por la misma transacción se devuelvan como parte de un lote atómico.
preferredLocations	Define las ubicaciones preferidas (regiones) para las cuentas de base de datos con replicación geográfica en el servicio Azure Cosmos DB. Los valores deben estar separados por comas. Por ejemplo, Este de EE. UU., Centro-sur de EE. UU., Norte de Europa
return	Configuración para la salida principal opcional de la función Esta es la salida principal que debe establecer como el valor devuelto del controlador de función durante la invocación.
startFromBeginning	Esta opción indica al desencadenador que lea los cambios desde el principio del historial de cambios del contenedor en lugar de comenzar en la hora actual. La lectura desde el principio solo funciona la primera vez que se inicia el desencadenador, como en ejecuciones posteriores, los puntos de control ya están almacenados. Establecer esta opción en true cuando ya hay concesiones creadas no tiene ningún efecto.
useMultipleWriteLocations	Habilita las cuentas de varias regiones para escribir en la colección de concesiones.

Detalles de las propiedades

handler

handler: CosmosDBv3Handler

Valor de propiedad

CosmosDBv3Handler

retry

Una directiva de reintento opcional para volver a ejecutar una ejecución con errores hasta que se produzca correctamente la finalización o se alcance el número máximo de reintentos. Obtenga más información aquí

retry?: RetryOptions

Valor de propiedad

RetryOptions

trigger

trigger?: CosmosDBv3Trigger

Valor de propiedad

CosmosDBv3Trigger

Detalles de las propiedades heredadas

checkpointDocumentCount

Personaliza la cantidad de documentos entre puntos de control de concesión. El valor predeterminado es después de cada llamada de función.

checkpointDocumentCount?: number

Valor de propiedad

number

heredado decosmosDBv3TriggerOptions.checkpointDocumentCount

checkpointInterval

Cuando se establece, define, en milisegundos, el intervalo entre los puntos de control de concesión. El valor predeterminado siempre es después de cada llamada de función.

checkpointInterval?: number

Valor de propiedad

number

heredado decosmosDBv3TriggerOptions.checkpointInterval

collectionName

Nombre de la colección que se está supervisando

collectionName: string

Valor de propiedad

string

Heredado deCosmosDBv3TriggerOptions.collectionName

connectionStringSetting

Una configuración de aplicación (o variable de entorno) con la cadena de conexión de Cosmos DB

connectionStringSetting: string

Valor de propiedad

string

Heredado deCosmosDBv3TriggerOptions.connectionStringSetting

createLeaseCollectionIfNotExists

Comprueba si existe y crea automáticamente la colección de concesiones. El valor predeterminado es false

createLeaseCollectionIfNotExists?: boolean

Valor de propiedad

boolean

Heredado deCosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

databaseName

Nombre de la base de datos de Azure Cosmos DB con la colección que se está supervisando

databaseName: string

Valor de propiedad

string

heredado decosmosDBv3TriggerOptions.databaseName

extraInputs

Configuración de un conjunto opcional de entradas secundarias Durante la invocación, obtenga estos valores con context.extraInputs.get()

extraInputs?: FunctionInput[]

Valor de propiedad

FunctionInput[]

Heredado de Partial.extraInputs

extraOutputs

Configuración de un conjunto opcional de salidas secundarias Durante la invocación, establezca estos valores con context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Valor de propiedad

FunctionOutput[]

Heredado de Partial.extraOutputs

feedPollDelay

Tiempo (en milisegundos) para el retraso entre sondear una partición para los nuevos cambios en la fuente, después de que se agoten todos los cambios actuales. El valor predeterminado es de 5000 milisegundos o 5 segundos.

feedPollDelay?: number

Valor de propiedad

number

heredado deCosmosDBv3TriggerOptions.feedPollDelay

leaseAcquireInterval

Cuando se establece, define, en milisegundos, el intervalo para iniciar una tarea para calcular si las particiones se distribuyen uniformemente entre instancias de host conocidas. El valor predeterminado es 13000 (13 segundos).

leaseAcquireInterval?: number

Valor de propiedad

number

heredado decosmosDBv3TriggerOptions.leaseAcquireInterval

leaseCollectionName

Nombre de la colección que se va a almacenar concesiones. Si no se establece, usará "concesiones"

leaseCollectionName?: string

Valor de propiedad

string

heredado deCosmosDBv3TriggerOptions.leaseCollectionName

leaseCollectionPrefix

Cuando se establece, el valor se agrega como prefijo a las concesiones creadas en la colección Lease para esta función. El uso de un prefijo permite que dos funciones independientes de Azure Functions compartan la misma colección de concesiones mediante prefijos diferentes.

leaseCollectionPrefix?: string

Valor de propiedad

string

heredado deCosmosDBv3TriggerOptions.leaseCollectionPrefix

leaseCollectionThroughput

Cuando createLeaseCollectionIfNotExists se establece en true, define la cantidad de unidades de solicitud que se asignarán a la colección de concesiones creada.

leaseCollectionThroughput?: number

Valor de propiedad

number

heredado decosmosDBv3TriggerOptions.leaseCollectionThroughput

leaseConnectionStringSetting

Nombre de una configuración de aplicación que contiene la cadena de conexión al servicio que contiene la colección de concesiones. Si no se establece, se conectará al servicio definido por connectionStringSetting

leaseConnectionStringSetting?: string

Valor de propiedad

string

Heredado deCosmosDBv3TriggerOptions.leaseConnectionStringSetting

leaseDatabaseName

Nombre de la base de datos que contiene la colección para almacenar concesiones. Si no se establece, usará el valor de databaseName

leaseDatabaseName?: string

Valor de propiedad

string

heredado decosmosDBv3TriggerOptions.leaseDatabaseName

leaseExpirationInterval

Cuando se establece, define, en milisegundos, el intervalo para el que se toma la concesión en una concesión que representa una partición. Si la concesión no se renueva dentro de este intervalo, hará que expire y la propiedad de la partición se moverá a otra instancia. El valor predeterminado es 60000 (60 segundos).

leaseExpirationInterval?: number

Valor de propiedad

number

heredado deCosmosDBv3TriggerOptions.leaseExpirationInterval

leaseRenewInterval

Cuando se establece, define, en milisegundos, el intervalo de renovación de todas las concesiones para las particiones que mantiene actualmente una instancia. El valor predeterminado es 17000 (17 segundos).

leaseRenewInterval?: number

Valor de propiedad

number

heredado decosmosDBv3TriggerOptions.leaseRenewInterval

maxItemsPerInvocation

Cuando se establece, esta propiedad establece el número máximo de elementos recibidos por llamada de función. Si las operaciones del contenedor supervisado se realizan mediante procedimientos almacenados, el ámbito de transacción se conserva al leer elementos de la fuente de cambios. Como resultado, el número de elementos recibidos podría ser mayor que el valor especificado para que los elementos modificados por la misma transacción se devuelvan como parte de un lote atómico.

maxItemsPerInvocation?: number

Valor de propiedad

number

heredado decosmosDBv3TriggerOptions.maxItemsPerInvocation

preferredLocations

Define las ubicaciones preferidas (regiones) para las cuentas de base de datos con replicación geográfica en el servicio Azure Cosmos DB. Los valores deben estar separados por comas. Por ejemplo, Este de EE. UU., Centro-sur de EE. UU., Norte de Europa

preferredLocations?: string

Valor de propiedad

string

heredado decosmosDBv3TriggerOptions.preferredLocations

return

Configuración para la salida principal opcional de la función Esta es la salida principal que debe establecer como el valor devuelto del controlador de función durante la invocación.

return?: FunctionOutput

Valor de propiedad

FunctionOutput

Heredado de Parcial.retorno

startFromBeginning

Esta opción indica al desencadenador que lea los cambios desde el principio del historial de cambios del contenedor en lugar de comenzar en la hora actual. La lectura desde el principio solo funciona la primera vez que se inicia el desencadenador, como en ejecuciones posteriores, los puntos de control ya están almacenados. Establecer esta opción en true cuando ya hay concesiones creadas no tiene ningún efecto.

startFromBeginning?: boolean

Valor de propiedad

boolean

Heredado deCosmosDBv3TriggerOptions.startFromBeginning

useMultipleWriteLocations

Habilita las cuentas de varias regiones para escribir en la colección de concesiones.

useMultipleWriteLocations?: boolean

Valor de propiedad

boolean

heredado deCosmosDBv3TriggerOptions.useMultipleWriteLocations