Package version:

Interface ContainerRequest

interface ContainerRequest {
    autoUpgradePolicy?: {
        throughputPolicy: {
            incrementPercent: number;
        };
    };
    changeFeedPolicy?: ChangeFeedPolicy;
    computedProperties?: ComputedProperty[];
    conflictResolutionPolicy?: ConflictResolutionPolicy;
    defaultTtl?: number;
    fullTextPolicy?: FullTextPolicy;
    geospatialConfig?: {
        type: GeospatialType;
    };
    id?: string;
    indexingPolicy?: IndexingPolicy;
    maxThroughput?: number;
    partitionKey?: string | PartitionKeyDefinition;
    throughput?: number;
    uniqueKeyPolicy?: UniqueKeyPolicy;
    vectorEmbeddingPolicy?: VectorEmbeddingPolicy;
}

Hierarchy

Properties

autoUpgradePolicy? changeFeedPolicy? computedProperties? conflictResolutionPolicy? defaultTtl? fullTextPolicy? geospatialConfig? id? indexingPolicy? maxThroughput? partitionKey? throughput? uniqueKeyPolicy? vectorEmbeddingPolicy?

Properties

OptionalautoUpgradePolicy

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

OptionalchangeFeedPolicy

changeFeedPolicy?: ChangeFeedPolicy

Change feed policy related to the container

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.

OptionalmaxThroughput

maxThroughput?: number

OptionalpartitionKey

partitionKey?: string | PartitionKeyDefinition

Optionalthroughput

throughput?: number

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