MongoDBCollectionResource interface

Package:

@azure/arm-cosmosdb

Cosmos DB MongoDB collection resource object

Properties

analyticalStorageTtl	Analytical TTL.
createMode	Enum to indicate the mode of resource creation.
id	Name of the Cosmos DB MongoDB collection
indexes	List of index keys
restoreParameters	Parameters to indicate the information about the restore
shardKey	A key-value pair of shard keys to be applied for the request.

Property Details

analyticalStorageTtl

Analytical TTL.

analyticalStorageTtl?: number

Property Value

number

createMode

Enum to indicate the mode of resource creation.

createMode?: string

Property Value

string

id

Name of the Cosmos DB MongoDB collection

id: string

Property Value

string

indexes

List of index keys

indexes?: MongoIndex[]

Property Value

MongoIndex[]

restoreParameters

Parameters to indicate the information about the restore

restoreParameters?: ResourceRestoreParameters

Property Value

ResourceRestoreParameters

shardKey

A key-value pair of shard keys to be applied for the request.

shardKey?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}