Table of Contents

Class ContainerPartitionKey

Namespace
Microsoft.Azure.Management.CosmosDB.Fluent.Models
Assembly
Microsoft.Azure.Management.CosmosDB.Fluent.dll

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

public class ContainerPartitionKey
Inheritance
ContainerPartitionKey
Inherited Members

Constructors

ContainerPartitionKey()

Initializes a new instance of the ContainerPartitionKey class.

public ContainerPartitionKey()

ContainerPartitionKey(IList<string>, PartitionKind, int?)

Initializes a new instance of the ContainerPartitionKey class.

public ContainerPartitionKey(IList<string> paths = null, PartitionKind kind = null, int? version = null)

Parameters

paths IList<string>

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

kind PartitionKind

Indicates the kind of algorithm used for partitioning. Possible values include: 'Hash', 'Range'

version int?

Indicates the version of the partition key definition

Properties

Kind

Gets or sets indicates the kind of algorithm used for partitioning. Possible values include: 'Hash', 'Range'

public PartitionKind Kind { get; set; }

Property Value

PartitionKind

Paths

Gets or sets list of paths using which data within the container can be partitioned

public IList<string> Paths { get; set; }

Property Value

IList<string>

Version

Gets or sets indicates the version of the partition key definition

public int? Version { get; set; }

Property Value

int?

Methods

Validate()

Validate the object.

public virtual void Validate()

Exceptions

Microsoft.Rest.ValidationException

Thrown if validation fails