MetricDefinition Class

Metric definition class specifies the metadata for a metric.

Inheritance

Model

MetricDefinition

Constructor

MetricDefinition(*, is_dimension_required: Optional[bool] = None, resource_id: Optional[str] = None, name: Optional[azure.mgmt.monitor.v2017_05_01_preview.models._models_py3.LocalizableString] = None, display_description: Optional[str] = None, category: Optional[str] = None, unit: Optional[Union[str, azure.mgmt.monitor.v2017_05_01_preview.models._monitor_management_client_enums.Unit]] = None, primary_aggregation_type: Optional[Union[str, azure.mgmt.monitor.v2017_05_01_preview.models._monitor_management_client_enums.AggregationType]] = None, metric_availabilities: Optional[List[azure.mgmt.monitor.v2017_05_01_preview.models._models_py3.MetricAvailability]] = None, id: Optional[str] = None, dimensions: Optional[List[azure.mgmt.monitor.v2017_05_01_preview.models._models_py3.LocalizableString]] = None, **kwargs)

Variables

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.

name

<xref:$>(<xref:python-base-namespace>)LocalizableString

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.

unit

str or <xref:$>(<xref:python-base-namespace>)Unit

the unit of the metric. Possible values include: "Count", "Bytes", "Seconds", "CountPerSecond", "BytesPerSecond", "Percent", "MilliSeconds", "ByteSeconds", "Unspecified", "Cores", "MilliCores", "NanoCores", "BitsPerSecond".

primary_aggregation_type

str or <xref:$>(<xref:python-base-namespace>)AggregationType

the primary aggregation type value defining how to use the values for display. Possible values include: "None", "Average", "Count", "Minimum", "Maximum", "Total".

metric_availabilities

list[<xref:$>(<xref:python-base-namespace>)MetricAvailability]

the collection of what aggregation intervals are available to be queried.

id

str

the resource identifier of the metric definition.

dimensions

list[<xref:$>(<xref:python-base-namespace>)LocalizableString]

the name and the display name of the dimension, i.e. it is a localizable string.