ThroughputSettingsResource interface

Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

Properties

autoscaleSettings

Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.

instantMaximumThroughput

The offer throughput value to instantly scale up without triggering splits

minimumThroughput

The minimum throughput of the resource

offerReplacePending

The throughput replace is pending

softAllowedMaximumThroughput

The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified

throughput

Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.

Property Details

autoscaleSettings

Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.

autoscaleSettings?: AutoscaleSettingsResource

Property Value

instantMaximumThroughput

The offer throughput value to instantly scale up without triggering splits

instantMaximumThroughput?: string

Property Value

string

minimumThroughput

The minimum throughput of the resource

minimumThroughput?: string

Property Value

string

offerReplacePending

The throughput replace is pending

offerReplacePending?: string

Property Value

string

softAllowedMaximumThroughput

The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified

softAllowedMaximumThroughput?: string

Property Value

string

throughput

Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.

throughput?: number

Property Value

number