PartitionMetric interface

  • Reference
Package:
@azure/arm-cosmosdb

The metric values for a single partition.

Extends
Metric

Properties

partitionId

The partition id (GUID identifier) of the metric values. 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 metric values. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

endTime

The end time for the metric (ISO-8601 format). NOTE: This property will not be serialized. It can only be populated by the server.
metricValues

The metric values for the specified time window and timestep. 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.
startTime

The start time for the metric (ISO-8601 format). NOTE: This property will not be serialized. It can only be populated by the server.
timeGrain

The time grain to be used to summarize the metric 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 metric values. 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 metric values. NOTE: This property will not be serialized. It can only be populated by the server.

partitionKeyRangeId?: string

Property Value

string

Inherited Property Details

endTime

The end time for the metric (ISO-8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

endTime?: Date

Property Value

Date

Inherited From Metric.endTime

metricValues

The metric values for the specified time window and timestep. NOTE: This property will not be serialized. It can only be populated by the server.

metricValues?: MetricValue[]

Property Value

MetricValue[]

Inherited From Metric.metricValues

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 Metric.name

startTime

The start time for the metric (ISO-8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

startTime?: Date

Property Value

Date

Inherited From Metric.startTime

timeGrain

The time grain to be used to summarize the metric values. NOTE: This property will not be serialized. It can only be populated by the server.

timeGrain?: string

Property Value

string

Inherited From Metric.timeGrain

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 Metric.unit