Package version:

Interface ContainerDefinition

interface ContainerDefinition {
    changeFeedPolicy?: ChangeFeedPolicy;
    clientEncryptionPolicy?: ClientEncryptionPolicy;
    computedProperties?: ComputedProperty[];
    conflictResolutionPolicy?: ConflictResolutionPolicy;
    defaultTtl?: number;
    fullTextPolicy?: FullTextPolicy;
    geospatialConfig?: {
        type: GeospatialType;
    };
    id?: string;
    indexingPolicy?: IndexingPolicy;
    partitionKey?: PartitionKeyDefinition;
    uniqueKeyPolicy?: UniqueKeyPolicy;
    vectorEmbeddingPolicy?: VectorEmbeddingPolicy;
}

Properties

changeFeedPolicy? clientEncryptionPolicy? computedProperties? conflictResolutionPolicy? defaultTtl? fullTextPolicy? geospatialConfig? id? indexingPolicy? partitionKey? uniqueKeyPolicy? vectorEmbeddingPolicy?

Properties

OptionalchangeFeedPolicy

changeFeedPolicy?: ChangeFeedPolicy

Change feed policy related to the container

OptionalclientEncryptionPolicy

clientEncryptionPolicy?: ClientEncryptionPolicy

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

OptionalcomputedProperties

computedProperties?: ComputedProperty[]

The computed properties of the container

OptionalconflictResolutionPolicy

conflictResolutionPolicy?: ConflictResolutionPolicy

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

OptionaldefaultTtl

defaultTtl?: number

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

OptionalfullTextPolicy

fullTextPolicy?: FullTextPolicy

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

OptionalgeospatialConfig

geospatialConfig?: {
    type: GeospatialType;
}

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

Optionalid

id?: string

The id of the container.

OptionalindexingPolicy

indexingPolicy?: IndexingPolicy

The indexing policy associated with the container.

OptionalpartitionKey

partitionKey?: PartitionKeyDefinition

The partition key for the container.

OptionaluniqueKeyPolicy

uniqueKeyPolicy?: UniqueKeyPolicy

Policy for additional keys that must be unique per partition key

OptionalvectorEmbeddingPolicy

vectorEmbeddingPolicy?: VectorEmbeddingPolicy

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

Settings

Member Visibility