CosmosDBv4InputOptions interface

Paquete:

@azure/functions

Propiedades

connection	Una configuración de aplicación (o variable de entorno) con la cadena de conexión de Cosmos DB
containerName	Nombre del contenedor que se está supervisando
databaseName	Nombre de la base de datos de Azure Cosmos DB con el contenedor que se está supervisando
id	Identificador del documento que se va a recuperar. Esta propiedad admite expresiones de enlace de . No establezca las propiedades id y sqlQuery. Si no establece ninguna de ellas, se recupera todo el contenedor.
partitionKey	Especifica el valor de clave de partición para la búsqueda. Puede incluir parámetros de enlace. Es necesario para las búsquedas en contenedores con particiones.
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
sqlQuery	Una consulta SQL de Azure Cosmos DB que se usa para recuperar varios documentos. La propiedad admite enlaces en tiempo de ejecución, como en este ejemplo: SELECT * FROM c where c.departmentId = {departmentId} No establecer las propiedades id y sqlQuery. Si no establece ninguna de ellas, se recupera todo el contenedor.

Detalles de las propiedades

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

containerName

Nombre del contenedor que se está supervisando

containerName: string

Valor de propiedad

string

databaseName

Nombre de la base de datos de Azure Cosmos DB con el contenedor que se está supervisando

databaseName: string

Valor de propiedad

string

id

Identificador del documento que se va a recuperar. Esta propiedad admite expresiones de enlace de . No establezca las propiedades id y sqlQuery. Si no establece ninguna de ellas, se recupera todo el contenedor.

id?: string

Valor de propiedad

string

partitionKey

Especifica el valor de clave de partición para la búsqueda. Puede incluir parámetros de enlace. Es necesario para las búsquedas en contenedores con particiones.

partitionKey?: string

Valor de propiedad

string

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

sqlQuery

Una consulta SQL de Azure Cosmos DB que se usa para recuperar varios documentos. La propiedad admite enlaces en tiempo de ejecución, como en este ejemplo: SELECT * FROM c where c.departmentId = {departmentId} No establecer las propiedades id y sqlQuery. Si no establece ninguna de ellas, se recupera todo el contenedor.

sqlQuery?: string

Valor de propiedad

string