Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
ContainerDefinition interface
- Package:
- @azure/cosmos
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. |
| partitionKey | The partition key for 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
changeFeedPolicy
Change feed policy related to the container
changeFeedPolicy?: ChangeFeedPolicyProperty Value
clientEncryptionPolicy
Encryption policy for the container, contains path that needs to be encrypted
clientEncryptionPolicy?: ClientEncryptionPolicyProperty Value
computedProperties
The computed properties of the container
computedProperties?: ComputedProperty[]Property Value
conflictResolutionPolicy
The conflict resolution policy used to resolve conflicts in a container.
conflictResolutionPolicy?: ConflictResolutionPolicyProperty Value
defaultTtl
The default time to live in seconds for items in a container.
defaultTtl?: numberProperty Value
number
fullTextPolicy
The full text policy information for storing items in a container.
fullTextPolicy?: FullTextPolicyProperty Value
geospatialConfig
Geospatial configuration for a collection. Type is set to Geography by default
geospatialConfig?: { type: GeospatialType }Property Value
{ type: GeospatialType }
id
The id of the container.
id?: stringProperty Value
string
indexingPolicy
The indexing policy associated with the container.
indexingPolicy?: IndexingPolicyProperty Value
partitionKey
The partition key for the container.
partitionKey?: PartitionKeyDefinitionProperty Value
uniqueKeyPolicy
Policy for additional keys that must be unique per partition key
uniqueKeyPolicy?: UniqueKeyPolicyProperty Value
vectorEmbeddingPolicy
The vector embedding policy information for storing items in a container.
vectorEmbeddingPolicy?: VectorEmbeddingPolicy