CosmosDBv3InputOptions interface

Eigenschappen

collectionName

De naam van de verzameling die wordt bewaakt

connectionStringSetting

Een app-instelling (of omgevingsvariabele) met de Cosmos DB-verbindingsreeks

databaseName

De naam van de Azure Cosmos DB-database met de verzameling die wordt bewaakt

id

De id van het document dat moet worden opgehaald. Deze eigenschap ondersteunt bindingexpressies. Stel de id- en sqlQuery-eigenschappen niet in. Als u geen van beide instellingen instelt, wordt de hele verzameling opgehaald.

partitionKey

Hiermee geeft u de partitiesleutelwaarde voor de zoekactie. Kan bindingsparameters bevatten. Het is vereist voor zoekacties in gepartitioneerde verzamelingen

preferredLocations

Definieert voorkeurslocaties (regio's) voor geo-gerepliceerde databaseaccounts in de Azure Cosmos DB-service. Waarden moeten door komma's worden gescheiden. Bijvoorbeeld VS - oost, VS - zuid-centraal, Europa - noord

sqlQuery

Een Azure Cosmos DB SQL-query die wordt gebruikt voor het ophalen van meerdere documenten. De eigenschap ondersteunt runtimebindingen, zoals in dit voorbeeld: SELECT * FROM c where c.departmentId = {departmentId} Stel de id- en sqlQuery-eigenschappen niet in. Als u geen van beide instellingen instelt, wordt de hele verzameling opgehaald.

Eigenschapdetails

collectionName

De naam van de verzameling die wordt bewaakt

collectionName: string

Waarde van eigenschap

string

connectionStringSetting

Een app-instelling (of omgevingsvariabele) met de Cosmos DB-verbindingsreeks

connectionStringSetting: string

Waarde van eigenschap

string

databaseName

De naam van de Azure Cosmos DB-database met de verzameling die wordt bewaakt

databaseName: string

Waarde van eigenschap

string

id

De id van het document dat moet worden opgehaald. Deze eigenschap ondersteunt bindingexpressies. Stel de id- en sqlQuery-eigenschappen niet in. Als u geen van beide instellingen instelt, wordt de hele verzameling opgehaald.

id?: string

Waarde van eigenschap

string

partitionKey

Hiermee geeft u de partitiesleutelwaarde voor de zoekactie. Kan bindingsparameters bevatten. Het is vereist voor zoekacties in gepartitioneerde verzamelingen

partitionKey?: string

Waarde van eigenschap

string

preferredLocations

Definieert voorkeurslocaties (regio's) voor geo-gerepliceerde databaseaccounts in de Azure Cosmos DB-service. Waarden moeten door komma's worden gescheiden. Bijvoorbeeld VS - oost, VS - zuid-centraal, Europa - noord

preferredLocations?: string

Waarde van eigenschap

string

sqlQuery

Een Azure Cosmos DB SQL-query die wordt gebruikt voor het ophalen van meerdere documenten. De eigenschap ondersteunt runtimebindingen, zoals in dit voorbeeld: SELECT * FROM c where c.departmentId = {departmentId} Stel de id- en sqlQuery-eigenschappen niet in. Als u geen van beide instellingen instelt, wordt de hele verzameling opgehaald.

sqlQuery?: string

Waarde van eigenschap

string