ThroughputSettingsResource interface

Package:

@azure/arm-cosmosdb

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 NOTE: This property will not be serialized. It can only be populated by the server.
minimumThroughput	The minimum throughput of the resource NOTE: This property will not be serialized. It can only be populated by the server.
offerReplacePending	The throughput replace is pending NOTE: This property will not be serialized. It can only be populated by the server.
softAllowedMaximumThroughput	The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified NOTE: This property will not be serialized. It can only be populated by the server.
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

AutoscaleSettingsResource

instantMaximumThroughput

The offer throughput value to instantly scale up without triggering splits NOTE: This property will not be serialized. It can only be populated by the server.

instantMaximumThroughput?: string

Property Value

string

minimumThroughput

The minimum throughput of the resource NOTE: This property will not be serialized. It can only be populated by the server.

minimumThroughput?: string

Property Value

string

offerReplacePending

The throughput replace is pending NOTE: This property will not be serialized. It can only be populated by the server.

offerReplacePending?: string

Property Value

string

softAllowedMaximumThroughput

The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified NOTE: This property will not be serialized. It can only be populated by the server.

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