SqlContainerResource Class

Cosmos DB SQL container resource object.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.cosmosdb._serialization.Model

SqlContainerResource

Constructor

SqlContainerResource(*, id: str, indexing_policy: _models.IndexingPolicy | None = None, partition_key: _models.ContainerPartitionKey | None = None, default_ttl: int | None = None, unique_key_policy: _models.UniqueKeyPolicy | None = None, conflict_resolution_policy: _models.ConflictResolutionPolicy | None = None, client_encryption_policy: _models.ClientEncryptionPolicy | None = None, analytical_storage_ttl: int | None = None, restore_parameters: _models.ResourceRestoreParameters | None = None, create_mode: str | _models.CreateMode = 'Default', computed_properties: List[_models.ComputedProperty] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str Name of the Cosmos DB SQL container. Required.
indexing_policy	IndexingPolicy The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container.
partition_key	ContainerPartitionKey The configuration of the partition key to be used for partitioning data into multiple partitions.
default_ttl	int Default time to live.
unique_key_policy	UniqueKeyPolicy The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
conflict_resolution_policy	ConflictResolutionPolicy The conflict resolution policy for the container.
client_encryption_policy	ClientEncryptionPolicy The client encryption policy for the container.
analytical_storage_ttl	int Analytical TTL.
restore_parameters	ResourceRestoreParameters Parameters to indicate the information about the restore.
create_mode	str or CreateMode Enum to indicate the mode of resource creation. Known values are: "Default" and "Restore". default value: Default
computed_properties	list[ComputedProperty] List of computed properties.

Variables

Name	Description
id	str Name of the Cosmos DB SQL container. Required.
indexing_policy	IndexingPolicy The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container.
partition_key	ContainerPartitionKey The configuration of the partition key to be used for partitioning data into multiple partitions.
default_ttl	int Default time to live.
unique_key_policy	UniqueKeyPolicy The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
conflict_resolution_policy	ConflictResolutionPolicy The conflict resolution policy for the container.
client_encryption_policy	ClientEncryptionPolicy The client encryption policy for the container.
analytical_storage_ttl	int Analytical TTL.
restore_parameters	ResourceRestoreParameters Parameters to indicate the information about the restore.
create_mode	str or CreateMode Enum to indicate the mode of resource creation. Known values are: "Default" and "Restore".
computed_properties	list[ComputedProperty] List of computed properties.