MongoDBCollectionGetPropertiesResource interface

Package:: @azure/arm-cosmosdb

model interface MongoDBCollectionGetPropertiesResource

Extends: MongoDBCollectionResource

Properties

etag	A system generated property representing the resource etag required for optimistic concurrency control.
rid	A system generated property. A unique identifier.
ts	A system generated property that denotes the last updated timestamp of the resource.

Inherited 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

etag

A system generated property representing the resource etag required for optimistic concurrency control.

etag?: string

Property Value

string

rid

A system generated property. A unique identifier.

rid?: string

Property Value

string

ts

A system generated property that denotes the last updated timestamp of the resource.

ts?: number

Property Value

number

Inherited Property Details

analyticalStorageTtl

Analytical TTL.

analyticalStorageTtl?: number

Property Value

number

Inherited From MongoDBCollectionResource.analyticalStorageTtl

createMode

Enum to indicate the mode of resource creation.

createMode?: string

Property Value

string

Inherited From MongoDBCollectionResource.createMode

id

Name of the Cosmos DB MongoDB collection

id: string

Property Value

string

Inherited From MongoDBCollectionResource.id

indexes

List of index keys

indexes?: MongoIndex[]

Property Value

MongoIndex[]

Inherited From MongoDBCollectionResource.indexes

restoreParameters

Parameters to indicate the information about the restore

restoreParameters?: ResourceRestoreParameters

Property Value

ResourceRestoreParameters

Inherited From MongoDBCollectionResource.restoreParameters

shardKey

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

shardKey?: Record<string, string>

Property Value

Record<string, string>

Inherited From MongoDBCollectionResource.shardKey