Msvm_AggregationMetricValue class

Represents the instance value of a metric defined by an instance of the Msvm_AggregationMetricDefinition class. The properties inherited from Msvm_BaseMetricValue provide the actual metric value. The properties defined by this class provide information about the interval over which the aggregation function was applied.

The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_AggregationMetricValue : CIM_AggregationMetricValue
{
  string   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  string   MetricDefinitionId;
  string   MeasuredElementName;
  datetime TimeStamp;
  datetime Duration;
  string   MetricValue;
  string   BreakdownDimension;
  string   BreakdownValue;
  boolean  Volatile;
  datetime AggregationTimeStamp;
  datetime AggregationDuration;
};

Members

The Msvm_AggregationMetricValue class has these types of members:

Properties

The Msvm_AggregationMetricValue class has these properties.

AggregationDuration

Data type: datetime

Access type: Read-only

Represents the time duration over which the aggregation was computed. The start of a monitoring interval over which the aggregation function is applied is determined by subtracting the AggregationDuration from the AggregationTimeStamp. This property is inherited from CIM_AggregationMetricValue.

AggregationTimeStamp

Data type: datetime

Access type: Read-only

Identifies the time when the aggregation function was applied to determine the value of the metric instance. This is not the same as the time when the instance was created. For a given CIM_AggregationMetricValue instance, the AggregationTimeStamp changes whenever the aggregation function is applied to calculate the value. This property is inherited from CIM_AggregationMetricValue.

BreakdownDimension

Data type: string

Access type: Read-only

Specifies one breakdown dimension from the BreakdownDimensions array defined in the associated Msvm_BaseMetricDefinition. This is the dimension along which this set of metric values is broken down. This property is inherited from CIM_BaseMetricDefinition.

BreakdownValue

Data type: string

Access type: Read-only

Defines a value of the BreakdownDimension property defined for this metric value instance. For example, if the BreakdownDimension is "TransactionName", this property could name the actual transaction to which this particular metric value applies. This property is inherited from CIM_BaseMetricDefinition.

Caption

Data type: string

Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement.

Description

Data type: string

Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement.

Duration

Data type: datetime

Access type: Read-only

Specifies the time duration over which this metric value is valid. This property should not exist for time stamps that apply only to a point in time, but should be specified for values that are considered valid for a certain time period (for example, sampling). If the Duration property exists and is not Null, the TimeStamp property specifies the end of the interval. This property is inherited from CIM_BaseMetricDefinition.

ElementName

Data type: string

Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

A string that uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

MeasuredElementName

Data type: string

Access type: Read-only

A descriptive name for the element to which the metric value belongs (the measured element). This property is inherited from CIM_BaseMetricDefinition.

MetricDefinitionId

Data type: string

Access type: Read-only

The key of the Msvm_BaseMetricDefinition instance for this value. This property is inherited from CIM_BaseMetricDefinition.

MetricValue

Data type: string

Access type: Read-only

The value of the metric that is represented as a string. This property is inherited from CIM_BaseMetricDefinition.

TimeStamp

Data type: datetime

Access type: Read-only

Specifies the time when the metric value was captured or computed. Be aware that this is different from the time when the instance was created. This property is inherited from CIM_BaseMetricDefinition.

Volatile

Data type: boolean

Access type: Read-only

True if the value for the next point in time will use the same class instance and just change the property values (such as the Value or TimeStamp). If True, the instance is reused. If False, the existing instances remain unchanged and a new instance is created for the new point in time. This property is inherited from CIM_BaseMetricDefinition.

Requirements

Minimum supported client
Windows 8 [desktop apps only]
Minimum supported server
Windows Server 2012 [desktop apps only]
Namespace
Root\Virtualization\V2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe