CosmosDBv4InputOptions interface
Propriedades
| connection | Uma configuração de aplicativo (ou variável de ambiente) com a cadeia de conexão do Cosmos DB |
| container |
O nome do contêiner que está sendo monitorado |
| database |
O nome do banco de dados do Azure Cosmos DB com o contêiner sendo monitorado |
| id | A ID do documento a ser recuperado. Essa propriedade dá suporte expressões de associação. Não defina as propriedades id e sqlQuery. Se você não definir nenhum dos dois, todo o contêiner será recuperado. |
| partition |
Especifica o valor da chave de partição para a pesquisa. Pode incluir parâmetros de associação. É necessário para pesquisas em contêineres particionados |
| preferred |
Define locais preferenciais (regiões) para contas de banco de dados replicadas geograficamente no serviço do Azure Cosmos DB. Os valores devem ser separados por vírgula. Por exemplo, Leste dos EUA, Centro-Sul dos EUA, Norte da Europa |
| sql |
Uma consulta SQL do Azure Cosmos DB usada para recuperar vários documentos. A propriedade dá suporte a associações de runtime, como neste exemplo:
|
Detalhes da propriedade
connection
Uma configuração de aplicativo (ou variável de ambiente) com a cadeia de conexão do Cosmos DB
connection: string
Valor da propriedade
string
containerName
O nome do contêiner que está sendo monitorado
containerName: string
Valor da propriedade
string
databaseName
O nome do banco de dados do Azure Cosmos DB com o contêiner sendo monitorado
databaseName: string
Valor da propriedade
string
id
A ID do documento a ser recuperado. Essa propriedade dá suporte expressões de associação. Não defina as propriedades id e sqlQuery. Se você não definir nenhum dos dois, todo o contêiner será recuperado.
id?: string
Valor da propriedade
string
partitionKey
Especifica o valor da chave de partição para a pesquisa. Pode incluir parâmetros de associação. É necessário para pesquisas em contêineres particionados
partitionKey?: string
Valor da propriedade
string
preferredLocations
Define locais preferenciais (regiões) para contas de banco de dados replicadas geograficamente no serviço do Azure Cosmos DB. Os valores devem ser separados por vírgula. Por exemplo, Leste dos EUA, Centro-Sul dos EUA, Norte da Europa
preferredLocations?: string
Valor da propriedade
string
sqlQuery
Uma consulta SQL do Azure Cosmos DB usada para recuperar vários documentos. A propriedade dá suporte a associações de runtime, como neste exemplo:
SELECT * FROM c where c.departmentId = {departmentId} Não defina as propriedades id e sqlQuery. Se você não definir nenhum dos dois, todo o contêiner será recuperado.
sqlQuery?: string
Valor da propriedade
string