PartitionUsage interface

Package:

@azure/arm-cosmosdb

The partition level usage data for a usage request.

Extends

Usage

Properties

partitionId	The partition id (GUID identifier) of the usages. NOTE: This property will not be serialized. It can only be populated by the server.
partitionKeyRangeId	The partition key range id (integer identifier) of the usages. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

currentValue	Current value for this metric NOTE: This property will not be serialized. It can only be populated by the server.
limit	Maximum value for this metric NOTE: This property will not be serialized. It can only be populated by the server.
name	The name information for the metric. NOTE: This property will not be serialized. It can only be populated by the server.
quotaPeriod	The quota period used to summarize the usage values. NOTE: This property will not be serialized. It can only be populated by the server.
unit	The unit of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

partitionId

The partition id (GUID identifier) of the usages. NOTE: This property will not be serialized. It can only be populated by the server.

partitionId?: string

Property Value

string

partitionKeyRangeId

The partition key range id (integer identifier) of the usages. NOTE: This property will not be serialized. It can only be populated by the server.

partitionKeyRangeId?: string

Property Value

string

Inherited Property Details

currentValue

Current value for this metric NOTE: This property will not be serialized. It can only be populated by the server.

currentValue?: number

Property Value

number

Inherited From Usage.currentValue

limit

Maximum value for this metric NOTE: This property will not be serialized. It can only be populated by the server.

limit?: number

Property Value

number

Inherited From Usage.limit

name

The name information for the metric. NOTE: This property will not be serialized. It can only be populated by the server.

name?: MetricName

Property Value

MetricName

Inherited From Usage.name

quotaPeriod

The quota period used to summarize the usage values. NOTE: This property will not be serialized. It can only be populated by the server.

quotaPeriod?: string

Property Value

string

Inherited From Usage.quotaPeriod

unit

The unit of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

unit?: string

Property Value

string

Inherited From Usage.unit