Share via


CosmosDbPartitionedStorageOptions Class

Definition

Cosmos DB Partitioned Storage Options.

public class CosmosDbPartitionedStorageOptions
type CosmosDbPartitionedStorageOptions = class
Public Class CosmosDbPartitionedStorageOptions
Inheritance
CosmosDbPartitionedStorageOptions

Constructors

CosmosDbPartitionedStorageOptions()

Properties

AuthKey

Gets or sets the authentication key for Cosmos DB.

CompatibilityMode

Gets or sets a value indicating whether or not to run in Compatibility Mode. Early versions of CosmosDb had a key length limit of 255. Keys longer than this were truncated in CosmosDbKeyEscape. This remains the default behavior, but can be overridden by setting CompatibilityMode to false. This setting will also allow for using older collections where no PartitionKey was specified.

Note: CompatibilityMode cannot be 'true' if KeySuffix is used.

ContainerId

Gets or sets the container identifier.

ContainerThroughput

Gets or sets the throughput set when creating the Container. Defaults to 400.

CosmosClientOptions

Gets or sets the options for the CosmosClient.

CosmosDbEndpoint

Gets or sets the CosmosDB endpoint.

DatabaseId

Gets or sets the database identifier for Cosmos DB instance.

KeySuffix

Gets or sets the suffix to be added to every key. EscapeKey(String).

Note: CompatibilityMode must be set to 'false' to use a KeySuffix. When KeySuffix is used, keys will NOT be truncated but an exception will be thrown if the key length is longer than allowed by CosmosDb.

TokenCredential

Gets or sets the token credential for Cosmos DB.

Applies to