ThroughputSettingsGetPropertiesResource interface
Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.
- Extends
Inherited Properties
autoscale |
Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. |
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. |
instant |
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. |
minimum |
The minimum throughput of the resource NOTE: This property will not be serialized. It can only be populated by the server. |
offer |
The throughput replace is pending NOTE: This property will not be serialized. It can only be populated by the server. |
rid | A system generated property. A unique identifier. NOTE: This property will not be serialized. It can only be populated by the server. |
soft |
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. |
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. |
Inherited Property Details
autoscaleSettings
Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.
autoscaleSettings?: AutoscaleSettingsResource
Property Value
Inherited From ThroughputSettingsResource.autoscaleSettings
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
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
Inherited From ThroughputSettingsResource.instantMaximumThroughput
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
Inherited From ThroughputSettingsResource.minimumThroughput
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
Inherited From ThroughputSettingsResource.offerReplacePending
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
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
Inherited From ThroughputSettingsResource.softAllowedMaximumThroughput
throughput
Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.
throughput?: number
Property Value
number
Inherited From ThroughputSettingsResource.throughput
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