ContainerRequest interface

Package:

@azure/cosmos

Extends

VerboseOmit<ContainerDefinition, "partitionKey">

Properties

autoUpgradePolicy
maxThroughput
partitionKey
throughput

Inherited Properties

changeFeedPolicy	Change feed policy related to the container
computedProperties	The computed properties of the container
conflictResolutionPolicy	The conflict resolution policy used to resolve conflicts in a container.
defaultTtl	The default time to live in seconds for items in a container.
fullTextPolicy	The full text policy information for storing items in a container.
geospatialConfig	Geospatial configuration for a collection. Type is set to Geography by default
id	The id of the container.
indexingPolicy	The indexing policy associated with the container.
uniqueKeyPolicy	Policy for additional keys that must be unique per partition key
vectorEmbeddingPolicy	The vector embedding policy information for storing items in a container.

Property Details

autoUpgradePolicy

autoUpgradePolicy?: { throughputPolicy: { incrementPercent: number } }

Property Value

{ throughputPolicy: { incrementPercent: number } }

maxThroughput

maxThroughput?: number

Property Value

number

partitionKey

partitionKey?: string | PartitionKeyDefinition

Property Value

string | PartitionKeyDefinition

throughput

throughput?: number

Property Value

number

Inherited Property Details

changeFeedPolicy

Change feed policy related to the container

changeFeedPolicy?: ChangeFeedPolicy

Property Value

ChangeFeedPolicy

Inherited From VerboseOmit.changeFeedPolicy

computedProperties

The computed properties of the container

computedProperties?: ComputedProperty[]

Property Value

ComputedProperty[]

Inherited From VerboseOmit.computedProperties

conflictResolutionPolicy

The conflict resolution policy used to resolve conflicts in a container.

conflictResolutionPolicy?: ConflictResolutionPolicy

Property Value

ConflictResolutionPolicy

Inherited From VerboseOmit.conflictResolutionPolicy

defaultTtl

The default time to live in seconds for items in a container.

defaultTtl?: number

Property Value

number

Inherited From VerboseOmit.defaultTtl

fullTextPolicy

The full text policy information for storing items in a container.

fullTextPolicy?: FullTextPolicy

Property Value

FullTextPolicy

Inherited From VerboseOmit.fullTextPolicy

geospatialConfig

Geospatial configuration for a collection. Type is set to Geography by default

geospatialConfig?: { type: GeospatialType }

Property Value

{ type: GeospatialType }

Inherited From VerboseOmit.geospatialConfig

id

The id of the container.

id?: string

Property Value

string

Inherited From VerboseOmit.id

indexingPolicy

The indexing policy associated with the container.

indexingPolicy?: IndexingPolicy

Property Value

IndexingPolicy

Inherited From VerboseOmit.indexingPolicy

uniqueKeyPolicy

Policy for additional keys that must be unique per partition key

uniqueKeyPolicy?: UniqueKeyPolicy

Property Value

UniqueKeyPolicy

Inherited From VerboseOmit.uniqueKeyPolicy

vectorEmbeddingPolicy

The vector embedding policy information for storing items in a container.

vectorEmbeddingPolicy?: VectorEmbeddingPolicy

Property Value

VectorEmbeddingPolicy

Inherited From VerboseOmit.vectorEmbeddingPolicy