Interface IWithPartitionKey

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent.SqlContainer.Update

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

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

public interface IWithPartitionKey

Methods

WithPartitionKey(ContainerPartitionKey)

Specifies the container partition key.

IUpdate WithPartitionKey(ContainerPartitionKey containerPartitionKey)

Parameters

containerPartitionKey ContainerPartitionKey

The whole object of the container partition key.

Returns

IUpdate

The next stage of the update.

WithPartitionKey(PartitionKind, int?)

Specifies the container partition key.

IUpdate 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 update.

Returns

IUpdate

The next stage of the update.

WithPartitionKeyPath(params string[])

Specifies the container partition key paths.

IUpdate WithPartitionKeyPath(params string[] paths)

Parameters

paths string[]

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

Returns

IUpdate

The next stage of the update.

WithoutPartitionKey()

Removes the container partition key.

IUpdate WithoutPartitionKey()

Returns

IUpdate

The next stage of the update.