CosmosDBv4LatestVersionFunctionOptions interface
- Extends
-
Omit<CosmosDBv4TriggerOptions, "changeFeedMode">,Partial<FunctionOptions>
Propiedades
| change |
|
| handler | El código que se ejecutará cuando se active tu función |
| 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. Más información aquí |
| trigger | Configuración de la entrada principal a la función, también conocido como el motivo por el que se desencadenará Esta es la única entrada que se pasa como argumento al controlador de funciones durante la invocación. |
Propiedades heredadas
| connection | Una configuración de aplicación (o variable de entorno) con la cadena de conexión de Cosmos DB |
| container |
Nombre del contenedor que se está supervisando |
| create |
Comprueba si existen y crea automáticamente el contenedor de concesiones. El valor predeterminado es |
| database |
Nombre de la base de datos de Azure Cosmos DB con el contenedor que se está supervisando |
| extra |
Configuración de un conjunto opcional de entradas secundarias Durante la invocación, obtenga estos valores con |
| extra |
Configuración de un conjunto opcional de salidas secundarias Durante la invocación, establezca estos valores con |
| feed |
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 5 000 milisegundos (o 5 segundos). |
| lease |
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 13 000 (13 segundos). |
| lease |
Nombre de una configuración de aplicación que contiene la cadena de conexión al servicio que contiene el contenedor de concesión.
Si no se establece, se conectará al servicio definido por |
| lease |
Nombre del contenedor que se va a almacenar concesiones. Si no se establece, usará "concesiones" |
| lease |
Cuando se establece, el valor se agrega como prefijo a las concesiones creadas en el contenedor De concesión para esta función. El uso de un prefijo permite que dos funciones de Azure Functions independientes compartan el mismo contenedor de concesiones con prefijos diferentes. |
| lease |
Nombre de la base de datos que contiene el contenedor para almacenar concesiones. Si no se establece, usará el valor de |
| lease |
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, expirará y la propiedad de la partición se moverá a otra instancia. El valor predeterminado es 60 000 (60 segundos). |
| lease |
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 17 000 (17 segundos). |
| leases |
Cuando |
| max |
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, es posible que el número de elementos recibidos sea mayor que el valor especificado, de modo que los elementos que cambian en la misma transacción se devuelvan como parte de un lote atómico. |
| preferred |
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. |
| start |
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, ya que en las 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.
No se admite cuando |
| start |
Obtiene o establece la fecha y hora desde la que se va a inicializar la operación de lectura de la fuente de cambios.
El formato recomendado es ISO 8601 con el designador UTC, como 2021-02-16T14:19:29Z.
Esto solo se usa para establecer el estado inicial del desencadenador. Una vez que el desencadenador tiene un estado de concesión, cambiar este valor no tiene ningún efecto.
No se admite cuando |
Detalles de las propiedades
changeFeedMode
handler
El código que se ejecutará cuando se active tu función
handler: CosmosDBv4Handler<T>
Valor de propiedad
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. Más información aquí
retry?: RetryOptions
Valor de propiedad
trigger
Configuración de la entrada principal a la función, también conocido como el motivo por el que se desencadenará Esta es la única entrada que se pasa como argumento al controlador de funciones durante la invocación.
trigger?: CosmosDBv4Trigger
Valor de propiedad
Detalles de las propiedades heredadas
connection
Una configuración de aplicación (o variable de entorno) con la cadena de conexión de Cosmos DB
connection: string
Valor de propiedad
string
Heredado de omit.connection
containerName
Nombre del contenedor que se está supervisando
containerName: string
Valor de propiedad
string
Heredado de omit.containerName
createLeaseContainerIfNotExists
Comprueba si existen y crea automáticamente el contenedor de concesiones. El valor predeterminado es false
createLeaseContainerIfNotExists?: boolean
Valor de propiedad
boolean
Heredado de Omit.createLeaseContainerIfNotExists
databaseName
Nombre de la base de datos de Azure Cosmos DB con el contenedor que se está supervisando
databaseName: string
Valor de propiedad
string
Heredado de omit.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
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
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 5 000 milisegundos (o 5 segundos).
feedPollDelay?: number
Valor de propiedad
number
Heredado de Omit.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 13 000 (13 segundos).
leaseAcquireInterval?: number
Valor de propiedad
number
Heredado de omit.leaseAcquireInterval
leaseConnection
Nombre de una configuración de aplicación que contiene la cadena de conexión al servicio que contiene el contenedor de concesión.
Si no se establece, se conectará al servicio definido por connection
leaseConnection?: string
Valor de propiedad
string
Heredado de omit.leaseConnection
leaseContainerName
Nombre del contenedor que se va a almacenar concesiones. Si no se establece, usará "concesiones"
leaseContainerName?: string
Valor de propiedad
string
Heredado de omit.leaseContainerName
leaseContainerPrefix
Cuando se establece, el valor se agrega como prefijo a las concesiones creadas en el contenedor De concesión para esta función. El uso de un prefijo permite que dos funciones de Azure Functions independientes compartan el mismo contenedor de concesiones con prefijos diferentes.
leaseContainerPrefix?: string
Valor de propiedad
string
Heredado de Omit.leaseContainerPrefix
leaseDatabaseName
Nombre de la base de datos que contiene el contenedor para almacenar concesiones. Si no se establece, usará el valor de databaseName
leaseDatabaseName?: string
Valor de propiedad
string
Heredado de Omit.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, expirará y la propiedad de la partición se moverá a otra instancia. El valor predeterminado es 60 000 (60 segundos).
leaseExpirationInterval?: number
Valor de propiedad
number
Heredado de omit.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 17 000 (17 segundos).
leaseRenewInterval?: number
Valor de propiedad
number
Heredado de omit.leaseRenewInterval
leasesContainerThroughput
Cuando createLeaseContainerIfNotExists se establece en true, define la cantidad de unidades de solicitud que se asignarán al contenedor de concesión creado.
leasesContainerThroughput?: number
Valor de propiedad
number
Heredado de Omit.leasesContainerThroughput
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, es posible que el número de elementos recibidos sea mayor que el valor especificado, de modo que los elementos que cambian en la misma transacción se devuelvan como parte de un lote atómico.
maxItemsPerInvocation?: number
Valor de propiedad
number
Heredado de Omit.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 de omit.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
Heredado de Partial.return
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, ya que en las 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.
No se admite cuando changeFeedMode es AllVersionsAndDeletes.
startFromBeginning?: boolean
Valor de propiedad
boolean
Heredado de Omit.startFromBeginning
startFromTime
Obtiene o establece la fecha y hora desde la que se va a inicializar la operación de lectura de la fuente de cambios.
El formato recomendado es ISO 8601 con el designador UTC, como 2021-02-16T14:19:29Z.
Esto solo se usa para establecer el estado inicial del desencadenador. Una vez que el desencadenador tiene un estado de concesión, cambiar este valor no tiene ningún efecto.
No se admite cuando changeFeedMode es AllVersionsAndDeletes.
startFromTime?: string
Valor de propiedad
string
Heredado de Omit.startFromTime