MetricDefinition Class

Metric definition class specifies the metadata for a metric.

Constructor

MetricDefinition(*, is_dimension_required: bool | None = None, resource_id: str | None = None, namespace: str | None = None, name: _models.LocalizableStringAutoGenerated | None = None, display_description: str | None = None, category: str | None = None, metric_class: str | _models.MetricClass | None = None, unit: str | _models.MetricUnit | None = None, primary_aggregation_type: str | _models.AggregationType | None = None, supported_aggregation_types: List[str | _models.AggregationType] | None = None, metric_availabilities: List[_models.MetricAvailability] | None = None, id: str | None = None, dimensions: List[_models.LocalizableStringAutoGenerated] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
is_dimension_required	bool Flag to indicate whether the dimension is required. Default value: None
resource_id	str The resource identifier of the resource that emitted the metric. Default value: None
namespace	str The namespace the metric belongs to. Default value: None
name	LocalizableStringAutoGenerated The name and the display name of the metric, i.e. it is a localizable string. Default value: None
display_description	str Detailed description of this metric. Default value: None
category	str Custom category name for this metric. Default value: None
metric_class	str or MetricClass The class of the metric. Known values are: "Availability", "Transactions", "Errors", "Latency", and "Saturation". Default value: None
unit	str or MetricUnit The unit of the metric. Known values are: "Count", "Bytes", "Seconds", "CountPerSecond", "BytesPerSecond", "Percent", "MilliSeconds", "ByteSeconds", "Unspecified", "Cores", "MilliCores", "NanoCores", and "BitsPerSecond". Default value: None
primary_aggregation_type	str or AggregationType The primary aggregation type value defining how to use the values for display. Known values are: "None", "Average", "Count", "Minimum", "Maximum", and "Total". Default value: None
supported_aggregation_types	list[str or AggregationType] The collection of what aggregation types are supported. Default value: None
metric_availabilities	list[MetricAvailability] The collection of what aggregation intervals are available to be queried. Default value: None
id	str The resource identifier of the metric definition. Default value: None
dimensions	list[LocalizableStringAutoGenerated] The name and the display name of the dimension, i.e. it is a localizable string. Default value: None

Variables

Name	Description
is_dimension_required	bool Flag to indicate whether the dimension is required.
resource_id	str The resource identifier of the resource that emitted the metric.
namespace	str The namespace the metric belongs to.
name	LocalizableStringAutoGenerated The name and the display name of the metric, i.e. it is a localizable string.
display_description	str Detailed description of this metric.
category	str Custom category name for this metric.
metric_class	str or MetricClass The class of the metric. Known values are: "Availability", "Transactions", "Errors", "Latency", and "Saturation".
unit	str or MetricUnit The unit of the metric. Known values are: "Count", "Bytes", "Seconds", "CountPerSecond", "BytesPerSecond", "Percent", "MilliSeconds", "ByteSeconds", "Unspecified", "Cores", "MilliCores", "NanoCores", and "BitsPerSecond".
primary_aggregation_type	str or AggregationType The primary aggregation type value defining how to use the values for display. Known values are: "None", "Average", "Count", "Minimum", "Maximum", and "Total".
supported_aggregation_types	list[str or AggregationType] The collection of what aggregation types are supported.
metric_availabilities	list[MetricAvailability] The collection of what aggregation intervals are available to be queried.
id	str The resource identifier of the metric definition.
dimensions	list[LocalizableStringAutoGenerated] The name and the display name of the dimension, i.e. it is a localizable string.