MetricDefinition Class

Metric definition class specifies the metadata for a metric.

Inheritance

Model

MetricDefinition

Constructor

MetricDefinition(*, resource_id: Optional[str] = None, resource_uri: Optional[str] = None, name: Optional[azure.mgmt.monitor.v2015_07_01.models._models_py3.LocalizableString] = None, category: Optional[str] = None, unit: Optional[Union[str, azure.mgmt.monitor.v2015_07_01.models._monitor_management_client_enums.Unit]] = None, start_time: Optional[datetime.datetime] = None, end_time: Optional[datetime.datetime] = None, primary_aggregation_type: Optional[Union[str, azure.mgmt.monitor.v2015_07_01.models._monitor_management_client_enums.AggregationType]] = None, supported_aggregation_types: Optional[List[Union[str, azure.mgmt.monitor.v2015_07_01.models._monitor_management_client_enums.AggregationType]]] = None, metric_availabilities: Optional[List[azure.mgmt.monitor.v2015_07_01.models._models_py3.MetricAvailability]] = None, id: Optional[str] = None, **kwargs)

Variables

resource_id

str

The resource identifier of the resource that emitted the metric.

resource_uri

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.

category

str

The category of 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".

start_time

datetime

Start time of the metadata request timespan.

end_time

datetime

End time of the metadata request timespan.

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".

supported_aggregation_types

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

List of all aggregations that are applicable for this metric.

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.