rename list_dimension_values (Azure#16292)

* rename list_dimension_values

* add samples

sdk/metricsadvisor/azure-ai-metricsadvisor/CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - AAD support authentication    #15922
 - `MetricsAdvisorKeyCredential` support for rotating the subscription and api keys to update long-lived clients
+
+**Breaking Changes**
+
+- `list_dimension_values` has been renamed to `list_anomaly_dimension_values`
 
 ## 1.0.0b2 (2020-11-10)
 

sdk/metricsadvisor/azure-ai-metricsadvisor/azure/ai/metricsadvisor/_metrics_advisor_client.py

@@ -492,7 +492,7 @@ def list_anomalies(self, **kwargs):
         return self._list_anomalies_for_alert(**kwargs)
 
     @distributed_trace
-    def list_dimension_values(
+    def list_anomaly_dimension_values(
             self, detection_configuration_id,
             dimension_name,
             start_time,
@@ -517,8 +517,8 @@ def list_dimension_values(
         .. admonition:: Example:
 
             .. literalinclude:: ../samples/sample_queries.py
-                :start-after: [START list_dimension_values]
-                :end-before: [END list_dimension_values]
+                :start-after: [START list_anomaly_dimension_values]
+                :end-before: [END list_anomaly_dimension_values]
                 :language: python
                 :dedent: 4
                 :caption: Query dimension values.

sdk/metricsadvisor/azure-ai-metricsadvisor/azure/ai/metricsadvisor/aio/_metrics_advisor_client_async.py

@@ -498,7 +498,7 @@ def list_anomalies(self, **kwargs):
         return self._list_anomalies_for_alert(**kwargs)
 
     @distributed_trace
-    def list_dimension_values(
+    def list_anomaly_dimension_values(
             self, detection_configuration_id,
             dimension_name,
             start_time,
@@ -523,8 +523,8 @@ def list_dimension_values(
         .. admonition:: Example:
 
             .. literalinclude:: ../samples/async_samples/sample_queries_async.py
-                :start-after: [START list_dimension_values_async]
-                :end-before: [END list_dimension_values_async]
+                :start-after: [START list_anomaly_dimension_values_async]
+                :end-before: [END list_anomaly_dimension_values_async]
                 :language: python
                 :dedent: 4
                 :caption: Query dimension values.

sdk/metricsadvisor/azure-ai-metricsadvisor/samples/async_samples/sample_queries_async.py

@@ -59,8 +59,8 @@ async def sample_list_metric_enriched_series_data_async():
 
     # [END list_metric_enriched_series_data_async]
 
-async def sample_list_dimension_values_async():
-    # [START list_dimension_values_async]
+async def sample_list_anomaly_dimension_values_async():
+    # [START list_anomaly_dimension_values_async]
     import datetime
     from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential
     from azure.ai.metricsadvisor.aio import MetricsAdvisorClient
@@ -75,7 +75,7 @@ async def sample_list_dimension_values_async():
                                   MetricsAdvisorKeyCredential(subscription_key, api_key))
 
     async with client:
-        results = client.list_dimension_values(
+        results = client.list_anomaly_dimension_values(
             detection_configuration_id=detection_configuration_id,
             dimension_name=dimension_name,
             start_time=datetime.datetime(2020, 1, 1),
@@ -84,7 +84,7 @@ async def sample_list_dimension_values_async():
         async for result in results:
             print(str(result))
 
-    # [END list_dimension_values_async]
+    # [END list_anomaly_dimension_values_async]
 
 async def sample_list_metric_dimension_values_async():
     # [START list_metric_dimension_values_async]
@@ -191,7 +191,7 @@ async def main():
     print("---List metric enriched series data...")
     await sample_list_metric_enriched_series_data_async()
     print("---List dimension values...")
-    await sample_list_dimension_values_async()
+    await sample_list_anomaly_dimension_values_async()
     print("---List metric dimension values...")
     await sample_list_metric_dimension_values_async()
     print("---List metric series data...")

sdk/metricsadvisor/azure-ai-metricsadvisor/samples/sample_queries.py

@@ -56,8 +56,8 @@ def sample_list_metric_enriched_series_data():
 
     # [END list_metric_enriched_series_data]
 
-def sample_list_dimension_values():
-    # [START list_dimension_values]
+def sample_list_anomaly_dimension_values():
+    # [START list_anomaly_dimension_values]
     import datetime
     from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorClient
 
@@ -70,7 +70,7 @@ def sample_list_dimension_values():
     client = MetricsAdvisorClient(service_endpoint,
                                   MetricsAdvisorKeyCredential(subscription_key, api_key))
 
-    results = client.list_dimension_values(
+    results = client.list_anomaly_dimension_values(
         detection_configuration_id=detection_configuration_id,
         dimension_name=dimension_name,
         start_time=datetime.datetime(2020, 1, 1),
@@ -79,7 +79,7 @@ def sample_list_dimension_values():
     for result in results:
         print(str(result))
 
-    # [END list_dimension_values]
+    # [END list_anomaly_dimension_values]
 
 def sample_list_metric_dimension_values():
     # [START list_metric_dimension_values]
@@ -178,7 +178,7 @@ def sample_list_metric_enrichment_status():
     print("---List metric enriched series data...")
     sample_list_metric_enriched_series_data()
     print("---List dimension values...")
-    sample_list_dimension_values()
+    sample_list_anomaly_dimension_values()
     print("---List metric dimension values...")
     sample_list_metric_dimension_values()
     print("---List metric series data...")