Aggregations must be plural + inclue types (Azure#19762)

* Aggreagations

* changelog

Author: Rakshith Bhyravabhotla

sdk/monitor/azure-monitor-query/CHANGELOG.md

@@ -4,8 +4,12 @@
 
 ### Features Added
 
+- Added enum `AggragationType` which can be used to specify aggregations in the query API.
+
 ### Breaking Changes
 
+- `aggregation` param in the query API is renamed to `aggregations`
+
 ### Bugs Fixed
 
 ### Other Changes

sdk/monitor/azure-monitor-query/azure/monitor/query/__init__.py

@@ -8,6 +8,7 @@
 from ._metrics_query_client import MetricsQueryClient
 
 from ._models import (
+    AggregationType,
     LogsQueryResults,
     LogsQueryResultTable,
     LogsQueryResultColumn,
@@ -27,6 +28,7 @@
 from ._version import VERSION
 
 __all__ = [
+    "AggregationType",
     "LogsQueryClient",
     "LogsBatchResults",
     "LogsBatchResultError",

sdk/monitor/azure-monitor-query/azure/monitor/query/_metrics_query_client.py

@@ -73,8 +73,9 @@ def query(self, resource_uri, metric_names, duration=None, **kwargs):
          with either start_time or duration.
         :keyword interval: The interval (i.e. timegrain) of the query.
         :paramtype interval: ~datetime.timedelta
-        :keyword aggregation: The list of aggregation types to retrieve.
-        :paramtype aggregation: list[str]
+        :keyword aggregations: The list of aggregation types to retrieve. Use `azure.monitor.query.AggregationType`
+         enum to get each aggregation type.
+        :paramtype aggregations: list[str]
         :keyword top: The maximum number of records to retrieve.
          Valid only if $filter is specified.
          Defaults to 10.
@@ -113,9 +114,9 @@ def query(self, resource_uri, metric_names, duration=None, **kwargs):
         """
         start = kwargs.pop('start_time', None)
         end = kwargs.pop('end_time', None)
-        aggregation = kwargs.pop("aggregation", None)
-        if aggregation:
-            kwargs.setdefault("aggregation", ",".join(aggregation))
+        aggregations = kwargs.pop("aggregations", None)
+        if aggregations:
+            kwargs.setdefault("aggregation", ",".join(aggregations))
         timespan = construct_iso8601(start, end, duration)
         kwargs.setdefault("metricnames", ",".join(metric_names))
         kwargs.setdefault("timespan", timespan)

sdk/monitor/azure-monitor-query/azure/monitor/query/_models.py

@@ -5,6 +5,7 @@
 # license information.
 # --------------------------------------------------------------------------
 
+from enum import Enum
 import uuid
 from typing import Any, Optional, List
 
@@ -566,3 +567,15 @@ def _from_generated(cls, generated):
             time_grain=generated.time_grain,
             retention=generated.retention
         )
+
+
+class AggregationType(str, Enum):
+    """the aggregation type of the metric.
+    """
+
+    NONE = "None"
+    AVERAGE = "Average"
+    COUNT = "Count"
+    MINIMUM = "Minimum"
+    MAXIMUM = "Maximum"
+    TOTAL = "Total"

sdk/monitor/azure-monitor-query/azure/monitor/query/aio/_metrics_query_client_async.py

@@ -68,8 +68,9 @@ async def query(
          with either start_time or duration.
         :keyword interval: The interval (i.e. timegrain) of the query.
         :paramtype interval: ~datetime.timedelta
-        :keyword aggregation: The list of aggregation types to retrieve.
-        :paramtype aggregation: list[str]
+        :keyword aggregations: The list of aggregation types to retrieve. Use `azure.monitor.query.AggregationType`
+         enum to get each aggregation type.
+        :paramtype aggregations: list[str]
         :keyword top: The maximum number of records to retrieve.
          Valid only if $filter is specified.
          Defaults to 10.
@@ -102,9 +103,9 @@ async def query(
         timespan = construct_iso8601(start, end, duration)
         kwargs.setdefault("metricnames", ",".join(metric_names))
         kwargs.setdefault("timespan", timespan)
-        aggregation = kwargs.pop("aggregation", None)
-        if aggregation:
-            kwargs.setdefault("aggregation", ",".join(aggregation))
+        aggregations = kwargs.pop("aggregations", None)
+        if aggregations:
+            kwargs.setdefault("aggregation", ",".join(aggregations))
         generated = await self._metrics_op.list(resource_uri, connection_verify=False, **kwargs)
         return MetricsResult._from_generated(generated) # pylint: disable=protected-access
 

sdk/monitor/azure-monitor-query/samples/sample_metrics_query_client.py

@@ -4,7 +4,7 @@
 import os
 from datetime import datetime, timedelta
 import urllib3
-from azure.monitor.query import MetricsQueryClient
+from azure.monitor.query import MetricsQueryClient, AggregationType
 from azure.identity import DefaultAzureCredential
 
 urllib3.disable_warnings()
@@ -22,7 +22,7 @@
     metric_names=["MatchedEventCount"],
     start_time=datetime(2021, 6, 21),
     duration=timedelta(days=1),
-    aggregation=['Count']
+    aggregations=[AggregationType.COUNT]
     )
 
 for metric in response.metrics:

sdk/monitor/azure-monitor-query/tests/async/test_metrics_client_async.py

@@ -2,6 +2,7 @@
 import pytest
 import os
 from azure.identity.aio import ClientSecretCredential
+from azure.monitor.query import AggregationType
 from azure.monitor.query.aio import MetricsQueryClient
 
 def _credential():
@@ -21,7 +22,7 @@ async def test_metrics_auth():
         metric_names=["MatchedEventCount"],
         start_time=datetime(2021, 6, 21),
         duration=timedelta(days=1),
-        aggregation=['Count']
+        aggregations=[AggregationType.COUNT]
         )
     assert response
     assert response.metrics

sdk/monitor/azure-monitor-query/tests/test_metrics_client.py

@@ -2,7 +2,7 @@
 import os
 from datetime import datetime, timedelta
 from azure.identity import ClientSecretCredential
-from azure.monitor.query import MetricsQueryClient
+from azure.monitor.query import MetricsQueryClient, AggregationType
 
 def _credential():
     credential  = ClientSecretCredential(
@@ -21,7 +21,7 @@ def test_metrics_auth():
         metric_names=["MatchedEventCount"],
         start_time=datetime(2021, 6, 21),
         duration=timedelta(days=1),
-        aggregation=['Count']
+        aggregations=[AggregationType.COUNT]
         )
     assert response
     assert response.metrics