CosmosDBContainerPartitionKey Class

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB.Models

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.11

Source:: CosmosDBContainerPartitionKey.cs

Source:: CosmosDBContainerPartitionKey.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public class CosmosDBContainerPartitionKey : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBContainerPartitionKey>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBContainerPartitionKey>

type CosmosDBContainerPartitionKey = class
    interface IJsonModel<CosmosDBContainerPartitionKey>
    interface IPersistableModel<CosmosDBContainerPartitionKey>

Public Class CosmosDBContainerPartitionKey
Implements IJsonModel(Of CosmosDBContainerPartitionKey), IPersistableModel(Of CosmosDBContainerPartitionKey)

Inheritance: Object
CosmosDBContainerPartitionKey

Implements: IJsonModel<CosmosDBContainerPartitionKey> IPersistableModel<CosmosDBContainerPartitionKey> IPersistableModel<T>

Constructors

CosmosDBContainerPartitionKey()

Initializes a new instance of CosmosDBContainerPartitionKey.

Properties

IsSystemKey	Indicates if the container is using a system generated partition key.
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.
Version	Indicates the version of the partition key definition.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CosmosDBContainerPartitionKey>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CosmosDBContainerPartitionKey>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<CosmosDBContainerPartitionKey>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CosmosDBContainerPartitionKey>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosDBContainerPartitionKey>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via