ContainerPartitionKey interface

Package:

@azure/arm-cosmosdb

The configuration of the partition key to be used for partitioning data into multiple partitions

Properties

kind	Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
paths	List of paths using which data within the container can be partitioned
systemKey	Indicates if the container is using a system generated partition key NOTE: This property will not be serialized. It can only be populated by the server.
version	Indicates the version of the partition key definition

Property Details

kind

Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create

kind?: string

Property Value

string

paths

List of paths using which data within the container can be partitioned

paths?: string[]

Property Value

string[]

systemKey

Indicates if the container is using a system generated partition key NOTE: This property will not be serialized. It can only be populated by the server.

systemKey?: boolean

Property Value

boolean

version

Indicates the version of the partition key definition

version?: number

Property Value

number