SqlContainerGetPropertiesResource interface

Package:

@azure/arm-cosmosdb

Cosmos DB SQL container resource object

Extends

SqlContainerResource,ExtendedResourceProperties

Inherited 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
etag	A system generated property representing the resource etag required for optimistic concurrency control. NOTE: This property will not be serialized. It can only be populated by the server.
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
rid	A system generated property. A unique identifier. NOTE: This property will not be serialized. It can only be populated by the server.
ts	A system generated property that denotes the last updated timestamp of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
uniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

Inherited Property Details

analyticalStorageTtl

Analytical TTL.

analyticalStorageTtl?: number

Property Value

number

Inherited From SqlContainerResource.analyticalStorageTtl

clientEncryptionPolicy

The client encryption policy for the container.

clientEncryptionPolicy?: ClientEncryptionPolicy

Property Value

ClientEncryptionPolicy

Inherited From SqlContainerResource.clientEncryptionPolicy

computedProperties

List of computed properties

computedProperties?: ComputedProperty[]

Property Value

ComputedProperty[]

Inherited From SqlContainerResource.computedProperties

conflictResolutionPolicy

The conflict resolution policy for the container.

conflictResolutionPolicy?: ConflictResolutionPolicy

Property Value

ConflictResolutionPolicy

Inherited From SqlContainerResource.conflictResolutionPolicy

createMode

Enum to indicate the mode of resource creation.

createMode?: string

Property Value

string

Inherited From SqlContainerResource.createMode

defaultTtl

Default time to live

defaultTtl?: number

Property Value

number

Inherited From SqlContainerResource.defaultTtl

etag

A system generated property representing the resource etag required for optimistic concurrency control. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From ExtendedResourceProperties.etag

id

Name of the Cosmos DB SQL container

id: string

Property Value

string

Inherited From SqlContainerResource.id

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

Inherited From SqlContainerResource.indexingPolicy

materializedViewDefinition

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

materializedViewDefinition?: MaterializedViewDefinition

Property Value

MaterializedViewDefinition

Inherited From SqlContainerResource.materializedViewDefinition

partitionKey

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

partitionKey?: ContainerPartitionKey

Property Value

ContainerPartitionKey

Inherited From SqlContainerResource.partitionKey

restoreParameters

Parameters to indicate the information about the restore

restoreParameters?: ResourceRestoreParameters

Property Value

ResourceRestoreParameters

Inherited From SqlContainerResource.restoreParameters

rid

A system generated property. A unique identifier. NOTE: This property will not be serialized. It can only be populated by the server.

rid?: string

Property Value

string

Inherited From ExtendedResourceProperties.rid

ts

A system generated property that denotes the last updated timestamp of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

ts?: number

Property Value

number

Inherited From ExtendedResourceProperties.ts

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

Inherited From SqlContainerResource.uniqueKeyPolicy