ThroughputSettingsGetPropertiesResource interface

Package:
@azure/arm-cosmosdb

model interface ThroughputSettingsGetPropertiesResource

Extends
ThroughputSettingsResource

Properties

etag

A system generated property representing the resource etag required for optimistic concurrency control.
rid

A system generated property. A unique identifier.
ts

A system generated property that denotes the last updated timestamp of the resource.

Inherited 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

etag

A system generated property representing the resource etag required for optimistic concurrency control.

etag?: string

Property Value

string

rid

A system generated property. A unique identifier.

rid?: string

Property Value

string

ts

A system generated property that denotes the last updated timestamp of the resource.

ts?: number

Property Value

number

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

AutoscaleSettingsResource

Inherited From ThroughputSettingsResource.autoscaleSettings

instantMaximumThroughput

The offer throughput value to instantly scale up without triggering splits

instantMaximumThroughput?: string

Property Value

string

Inherited From ThroughputSettingsResource.instantMaximumThroughput

minimumThroughput

The minimum throughput of the resource

minimumThroughput?: string

Property Value

string

Inherited From ThroughputSettingsResource.minimumThroughput

offerReplacePending

The throughput replace is pending

offerReplacePending?: string

Property Value

string

Inherited From ThroughputSettingsResource.offerReplacePending

softAllowedMaximumThroughput

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

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