Interface IWithPartitionKey<ParentT>

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent.SqlContainer.Definition

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

The stage of a SQL container definition allowing to set partition key.

public interface IWithPartitionKey<ParentT>

Type Parameters

ParentT

The stage of the parent definition to return to after attaching this definition.

Methods

WithPartitionKey(ContainerPartitionKey)

Specifies the container partition key.

IWithAttach<ParentT> WithPartitionKey(ContainerPartitionKey containerPartitionKey)

Parameters

containerPartitionKey ContainerPartitionKey

The whole object of the container partition key.

Returns

IWithAttach<ParentT>

The next stage of the definition.

WithPartitionKey(PartitionKind, int?)

Specifies the container partition key.

IWithAttach<ParentT> WithPartitionKey(PartitionKind kind, int? version)

Parameters

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.

Returns

IWithAttach<ParentT>

The next stage of the definition.

WithPartitionKeyPath(params string[])

Specifies the container partition key paths.

IWithAttach<ParentT> WithPartitionKeyPath(params string[] paths)

Parameters

paths string[]

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

Returns

IWithAttach<ParentT>

The next stage of the definition.