SqlContainerResource interface

Package:

@azure/arm-cosmosdb

Cosmos DB SQL container resource object

Properties

analyticalStorageTtl	Analytical TTL.
clientEncryptionPolicy	The client encryption policy for the container.
computedProperties	List of computed properties
conflictResolutionPolicy	The conflict resolution policy for the container.
createMode	Enum to indicate the mode of resource creation.
defaultTtl	Default time to live
id	Name of the Cosmos DB SQL container
indexingPolicy	The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
materializedViewDefinition	The configuration for defining Materialized Views. This must be specified only for creating a Materialized View container.
partitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions
restoreParameters	Parameters to indicate the information about the restore
uniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

Property Details

analyticalStorageTtl

Analytical TTL.

analyticalStorageTtl?: number

Property Value

number

clientEncryptionPolicy

The client encryption policy for the container.

clientEncryptionPolicy?: ClientEncryptionPolicy

Property Value

ClientEncryptionPolicy

computedProperties

List of computed properties

computedProperties?: ComputedProperty[]

Property Value

ComputedProperty[]

conflictResolutionPolicy

The conflict resolution policy for the container.

conflictResolutionPolicy?: ConflictResolutionPolicy

Property Value

ConflictResolutionPolicy

createMode

Enum to indicate the mode of resource creation.

createMode?: string

Property Value

string

defaultTtl

Default time to live

defaultTtl?: number

Property Value

number

id

Name of the Cosmos DB SQL container

id: string

Property Value

string

indexingPolicy

The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container

indexingPolicy?: IndexingPolicy

Property Value

IndexingPolicy

materializedViewDefinition

The configuration for defining Materialized Views. This must be specified only for creating a Materialized View container.

materializedViewDefinition?: MaterializedViewDefinition

Property Value

MaterializedViewDefinition

partitionKey

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

partitionKey?: ContainerPartitionKey

Property Value

ContainerPartitionKey

restoreParameters

Parameters to indicate the information about the restore

restoreParameters?: ResourceRestoreParameters

Property Value

ResourceRestoreParameters

uniqueKeyPolicy

The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

uniqueKeyPolicy?: UniqueKeyPolicy

Property Value

UniqueKeyPolicy