Share via

ThroughputProperties Class

  • Reference

Represents the throughput properties in an Azure Cosmos DB SQL API container.

To read and update throughput properties, use the associated methods on the <xref:Container>. If configuring auto-scale, auto_scale_max_throughput needs to be set and auto_scale_increment_percent can also be set in conjunction with it. The value of offer_throughput will not be allowed to be set in conjunction with the auto-scale settings.

Inheritance
builtins.object
ThroughputProperties

Constructor

ThroughputProperties(*args, **kwargs)

Keyword-Only Parameters

Name Description
offer_throughput
int

The provisioned throughput in request units per second as a number.
auto_scale_max_throughput
int

The max auto-scale throughput. It should have a valid throughput value between 1000 and 1000000 inclusive, in increments of 1000.
auto_scale_increment_percent
int

is the % from the base selected RU it increases at a given time, the increment percent should be greater than or equal to zero.