ArmCosmosDBModelFactory.CosmosDBContainerPartitionKey Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB.Models

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

ArmCosmosDBModelFactory.cs

Initializes a new instance of CosmosDBContainerPartitionKey.

public static Azure.ResourceManager.CosmosDB.Models.CosmosDBContainerPartitionKey CosmosDBContainerPartitionKey (System.Collections.Generic.IEnumerable<string> paths = default, Azure.ResourceManager.CosmosDB.Models.CosmosDBPartitionKind? kind = default, int? version = default, bool? isSystemKey = default);

static member CosmosDBContainerPartitionKey : seq<string> * Nullable<Azure.ResourceManager.CosmosDB.Models.CosmosDBPartitionKind> * Nullable<int> * Nullable<bool> -> Azure.ResourceManager.CosmosDB.Models.CosmosDBContainerPartitionKey

Public Shared Function CosmosDBContainerPartitionKey (Optional paths As IEnumerable(Of String) = Nothing, Optional kind As Nullable(Of CosmosDBPartitionKind) = Nothing, Optional version As Nullable(Of Integer) = Nothing, Optional isSystemKey As Nullable(Of Boolean) = Nothing) As CosmosDBContainerPartitionKey

Parameters

paths

IEnumerable<String>

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

kind

Nullable<CosmosDBPartitionKind>

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

version

Nullable<Int32>

Indicates the version of the partition key definition.

isSystemKey

Nullable<Boolean>

Indicates if the container is using a system generated partition key.

Returns

CosmosDBContainerPartitionKey

A new CosmosDBContainerPartitionKey instance for mocking.