MetricSpecificationV1 Class

Metric specification version 1.

Inheritance

Model

MetricSpecificationV1

Constructor

MetricSpecificationV1(*, name: Optional[str] = None, display_name: Optional[str] = None, display_description: Optional[str] = None, unit=None, aggregation_type=None, dimensions=None, fill_gap_with_zero: Optional[bool] = None, category=None, resource_id_dimension_name_override: Optional[str] = None, supported_time_grain_types=None, supported_aggregation_types=None, **kwargs)

Parameters

name

str

Required

Name of the metric.

display_name

str

Required

Display name of the metric.

display_description

str

Required

Description of the metric to be displayed.

unit

str or MetricUnit

Required

Metric units. Possible values include: 'NotSpecified', 'Percent', 'Count', 'Seconds', 'Milliseconds', 'Bytes', 'BytesPerSecond', 'CountPerSecond'

aggregation_type

str or MetricAggregationType

Required

Metric aggregation type. Possible values include: 'NotSpecified', 'None', 'Average', 'Minimum', 'Maximum', 'Total', 'Count'

dimensions

list[MetricDimensionV1]

Required

Metric dimensions, other than default dimension which is resource.

fill_gap_with_zero

bool

Required

Set true to fill the gaps with zero.

category

str or MetricCategory

Required

Metric category. Possible values include: 'Capacity', 'Transaction'

resource_id_dimension_name_override

str

Required

Resource name override.

supported_time_grain_types

list[str or TimeGrain]

Required

Support granularity of metrics.

supported_aggregation_types

list[str or MetricAggregationType]

Required

Support metric aggregation type.