Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

ContainerRequest interface

Package:
@azure/cosmos
Extends

VerboseOmit<ContainerDefinition, "partitionKey">

Properties

autoUpgradePolicy
maxThroughput
partitionKey
throughput

Inherited Properties

changeFeedPolicy

Change feed policy related to the container
clientEncryptionPolicy

Encryption policy for the container, contains path that needs to be encrypted
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

throughput 

throughput?: number

Property Value

number

Inherited Property Details

changeFeedPolicy

Change feed policy related to the container

changeFeedPolicy?: ChangeFeedPolicy

Property Value

Inherited From VerboseOmit.changeFeedPolicy

clientEncryptionPolicy

Encryption policy for the container, contains path that needs to be encrypted

clientEncryptionPolicy?: ClientEncryptionPolicy

Property Value

Inherited From VerboseOmit.clientEncryptionPolicy

computedProperties

The computed properties of the container

computedProperties?: ComputedProperty[]

Property Value

Inherited From VerboseOmit.computedProperties

conflictResolutionPolicy

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

conflictResolutionPolicy?: ConflictResolutionPolicy

Property Value

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

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

Inherited From VerboseOmit.indexingPolicy

uniqueKeyPolicy

Policy for additional keys that must be unique per partition key

uniqueKeyPolicy?: UniqueKeyPolicy

Property Value

Inherited From VerboseOmit.uniqueKeyPolicy

vectorEmbeddingPolicy

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

vectorEmbeddingPolicy?: VectorEmbeddingPolicy

Property Value

Inherited From VerboseOmit.vectorEmbeddingPolicy