MongoDBCollectionGetPropertiesResource interface

Package:

@azure/arm-cosmosdb

Cosmos DB MongoDB collection resource object

Extends

MongoDBCollectionResource,ExtendedResourceProperties

Inherited Properties

analyticalStorageTtl	Analytical TTL.
createMode	Enum to indicate the mode of resource creation.
etag	A system generated property representing the resource etag required for optimistic concurrency control. NOTE: This property will not be serialized. It can only be populated by the server.
id	Name of the Cosmos DB MongoDB collection
indexes	List of index keys
restoreParameters	Parameters to indicate the information about the restore
rid	A system generated property. A unique identifier. NOTE: This property will not be serialized. It can only be populated by the server.
shardKey	A key-value pair of shard keys to be applied for the request.
ts	A system generated property that denotes the last updated timestamp of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

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

etag

A system generated property representing the resource etag required for optimistic concurrency control. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From ExtendedResourceProperties.etag

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

rid

A system generated property. A unique identifier. NOTE: This property will not be serialized. It can only be populated by the server.

rid?: string

Property Value

string

Inherited From ExtendedResourceProperties.rid

shardKey

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

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

Property Value

{[propertyName: string]: string}

Inherited From MongoDBCollectionResource.shardKey

ts

A system generated property that denotes the last updated timestamp of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

ts?: number

Property Value

number

Inherited From ExtendedResourceProperties.ts