From 4ed905a6bcdb47519befd1c0da9a8c028c88d459 Mon Sep 17 00:00:00 2001
From: rakeshrana44 <73717426+rakeshrana44@users.noreply.github.com>
Date: Wed, 9 Jun 2021 01:43:09 -0700
Subject: [PATCH] update description of filter and metric names (#14707)
* update description of filter and metric names
update description of filter and metric names
* update metricBaselines_API filter & metricnames
update metricBaselines_API filter & metricnames
* update metricBaselines_API filter & metricnames
update metricBaselines_API with filter & metricnames
* correctly updating the changes
correctly updating the changes
* update description of metricNamesParameter
update description of metricNamesParameter
* adding word
adding word
---
custom-words.txt | 1 +
.../Microsoft.Insights/stable/2018-01-01/metrics_API.json | 4 ++--
.../Microsoft.Insights/stable/2018-09-01/baseline_API.json | 2 +-
.../stable/2018-09-01/metricBaselines_API.json | 4 ++--
.../stable/2019-03-01/metricBaselines_API.json | 4 ++--
5 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/custom-words.txt b/custom-words.txt
index b912ee78b4e1..d2138957dce2 100644
--- a/custom-words.txt
+++ b/custom-words.txt
@@ -1109,6 +1109,7 @@ Metastores
Metric's
metricdefinitions
metricmetadata
+metricname
metricnames
metricnamespace
metricsadvisor
diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json
index 3f1ba6e80cb9..ebe83fb067d3 100644
--- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json
+++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json
@@ -66,7 +66,7 @@
"name": "$filter",
"in": "query",
"type": "string",
- "description": "The **$filter** is used to reduce the set of metric data returned.
Example:
Metric contains metadata A, B and C.
- Return all time series of C where A = a1 and B = b1 or b2
**$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical or operator cannot separate two different metadata names.
- Return all time series where A = a1, B = b1 and C = c1:
**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
- Return all time series where A = a1
**$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.",
+ "description": "The **$filter** is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 **$filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'** - Invalid variant: **$filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'** This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: **$filter=A eq 'a1' and B eq 'b1' and C eq 'c1'** - Return all time series where A = a1 **$filter=A eq 'a1' and B eq '*' and C eq '*'**. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is **dim (test) 1** Instead of using $filter= \"dim (test) 1 eq '*' \" use **$filter= \"dim %2528test%2529 1 eq '*' \"** When dimension name is **dim (test) 3** and dimension value is **dim3 (test) val** Instead of using $filter= \"dim (test) 3 eq 'dim3 (test) val' \" use **$filter= \"dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' \"**",
"required": false
},
{
@@ -348,7 +348,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The names of the metrics (comma separated) to retrieve.",
+ "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**",
"x-ms-parameter-location": "method"
},
"AggregationsParameter": {
diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/baseline_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/baseline_API.json
index 1a9d8374b633..d2ba6d2ba226 100644
--- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/baseline_API.json
+++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/baseline_API.json
@@ -440,7 +440,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The names of the metrics (comma separated) to retrieve.",
+ "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**",
"x-ms-parameter-location": "method"
},
"AggregationParameter": {
diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json
index cbf5493c2171..39a35c8d609e 100644
--- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json
+++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/metricBaselines_API.json
@@ -78,7 +78,7 @@
"name": "$filter",
"in": "query",
"type": "string",
- "description": "The **$filter** is used to reduce the set of metric data returned.
Example:
Metric contains metadata A, B and C.
- Return all time series of C where A = a1 and B = b1 or b2
**$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical or operator cannot separate two different metadata names.
- Return all time series where A = a1, B = b1 and C = c1:
**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
- Return all time series where A = a1
**$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.",
+ "description": "The **$filter** is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 **$filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'** - Invalid variant: **$filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'** This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: **$filter=A eq 'a1' and B eq 'b1' and C eq 'c1'** - Return all time series where A = a1 **$filter=A eq 'a1' and B eq '*' and C eq '*'**. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is **dim (test) 1** Instead of using $filter= \"dim (test) 1 eq '*' \" use **$filter= \"dim %2528test%2529 1 eq '*' \"** When dimension name is **dim (test) 3** and dimension value is **dim3 (test) val** Instead of using $filter= \"dim (test) 3 eq 'dim3 (test) val' \" use **$filter= \"dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' \"**",
"required": false
},
{
@@ -334,7 +334,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The names of the metrics (comma separated) to retrieve.",
+ "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**",
"x-ms-parameter-location": "method"
},
"MetricNamespaceParameter": {
diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json
index af1167214569..42b89e85889e 100644
--- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json
+++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json
@@ -78,7 +78,7 @@
"name": "$filter",
"in": "query",
"type": "string",
- "description": "The **$filter** is used to reduce the set of metric data returned.
Example:
Metric contains metadata A, B and C.
- Return all time series of C where A = a1 and B = b1 or b2
**$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical or operator cannot separate two different metadata names.
- Return all time series where A = a1, B = b1 and C = c1:
**$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
- Return all time series where A = a1
**$filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.",
+ "description": "The **$filter** is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 **$filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'** - Invalid variant: **$filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'** This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: **$filter=A eq 'a1' and B eq 'b1' and C eq 'c1'** - Return all time series where A = a1 **$filter=A eq 'a1' and B eq '*' and C eq '*'**. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is **dim (test) 1** Instead of using $filter= \"dim (test) 1 eq '*' \" use **$filter= \"dim %2528test%2529 1 eq '*' \"** When dimension name is **dim (test) 3** and dimension value is **dim3 (test) val** Instead of using $filter= \"dim (test) 3 eq 'dim3 (test) val' \" use **$filter= \"dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' \"**",
"required": false
},
{
@@ -345,7 +345,7 @@
"in": "query",
"required": false,
"type": "string",
- "description": "The names of the metrics (comma separated) to retrieve.",
+ "description": "The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be **'Metric%2Name1'**",
"x-ms-parameter-location": "method"
},
"MetricNamespaceParameter": {