[Hub Generated] Review request for Microsoft.Insights to add version …

…stable/2018-01-01 (Azure#14009) * Fix swagger correctness issues with 2017-05-01-preview metricdefinitions * Fix swagger correctness issues with 2017-05-01-preview metrics API * Fix swagger correctness issues with 2017-12-01-preview metricNamespaces API * Update 2017-12-01-preview metricNamespaces example * Fix swagger correctness issues with 2016-09-01 metricDefinitions API * Fix swagger correctness issues with 2016-09-01 metrics API * Add additional 2018-01-01 metricDefinitions API example Shows additional metric properties like category. * Fix swagger correctness issues with 2018-01-01 metricDefinitions API Fix swagger correctness issues with 2018-01-01 metricDefinitions API Also add an extra example * Fix swagger correctness issues with 2018-01-01 metrics API * Remove extra forward slash from 2016-03-01 metricDefinitions example * Remove extra forward slash from 2016-03-01 metricDefinitions filtered example * Remove forward slash from 2016-09-01 metrics example * Remove forward slash from 2016-09-01 metrics filtered example * Update 2017-05-01-preview example with current values * Update 2017-05-01-preview metric metadata example * Remove isMetadataCustom property from example * Clarified some comments in 2018-01-01 metrics API * Fix example in 2018-01-01 metrics metadata API * Fix example and comments in 2017-05-01-preview metrics API * Update 2017-05-01-preview get metric metradata example * Fix formatting issues with 2017-05-01-preview metrics API * Fix formatting issues with 2017-12-01-preview metricNamespaces API * Fix formatting issues with 2018-01-01 metrics API * Add displayDescription to 2018-01-01 metrics API example
mkarmark · Jul 20, 2021 · 4e1705a · 4e1705a
1 parent 7a5a33f
commit 4e1705a
Show file tree

Hide file tree

Showing 17 changed files with 2,172 additions and 66 deletions.
diff --git a/...or/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/GetMetric.json b/...or/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/GetMetric.json
@@ -1,31 +1,75 @@
 {
   "parameters": {
-    "resourceUri": "subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default",
-    "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z",
+    "resourceUri": "d69f0a10-6508-4026-98b0-eff8f6faaade/resourceGroups/quickpulse-int/providers/Microsoft.Storage/storageAccounts/quickpulseintusscdiag/blobServices/default",
+    "timespan": "2021-04-16T01:00:00.000Z/2021-04-17T02:00:00.000Z",
     "metric": "BlobCapacity",
     "$filter": "BlobType eq '*'",
     "top": "3",
-    "orderby": "Average asc",
-    "aggregation": "Average,count",
-    "interval": "PT1M",
+    "orderby": "Average desc",
+    "aggregation": "average,minimum,maximum",
+    "interval": "PT6H",
     "api-version": "2017-05-01-preview"
   },
   "responses": {
     "200": {
       "body": {
-        "cost": 0,
-        "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z",
-        "interval": "PT1M",
+        "cost": 1499,
+        "timespan": "2021-04-16T01:00:00Z/2021-04-17T02:00:00Z",
+        "interval": "PT6H",
         "value": [
           {
-            "id": "/subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity",
+            "id": "/subscriptions/d69f0a10-6508-4026-98b0-eff8f6faaade/resourceGroups/quickpulse-int/providers/Microsoft.Storage/storageAccounts/quickpulseintusscdiag/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity",
             "type": "Microsoft.Insights/metrics",
             "name": {
               "value": "BlobCapacity",
               "localizedValue": "Blob Capacity"
             },
+            "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.",
             "unit": "Bytes",
             "timeseries": [
+              {
+                "metadatavalues": [
+                  {
+                    "name": {
+                      "value": "blobtype",
+                      "localizedValue": "blobtype"
+                    },
+                    "value": "BlockBlob"
+                  }
+                ],
+                "data": [
+                  {
+                    "timeStamp": "2021-04-16T01:00:00Z",
+                    "average": 35492299169.0,
+                    "minimum": 35492299169.0,
+                    "maximum": 35492299169.0
+                  },
+                  {
+                    "timeStamp": "2021-04-16T07:00:00Z",
+                    "average": 35492299169.0,
+                    "minimum": 35492299169.0,
+                    "maximum": 35492299169.0
+                  },
+                  {
+                    "timeStamp": "2021-04-16T13:00:00Z",
+                    "average": 35492299169.0,
+                    "minimum": 35492299169.0,
+                    "maximum": 35492299169.0
+                  },
+                  {
+                    "timeStamp": "2021-04-16T19:00:00Z",
+                    "average": 35492299169.0,
+                    "minimum": 35492299169.0,
+                    "maximum": 35492299169.0
+                  },
+                  {
+                    "timeStamp": "2021-04-17T01:00:00Z",
+                    "average": 35492299169.0,
+                    "minimum": 35492299169.0,
+                    "maximum": 35492299169.0
+                  }
+                ]
+              },
               {
                 "metadatavalues": [
                   {
@@ -38,21 +82,34 @@
                 ],
                 "data": [
                   {
-                    "timeStamp": "2017-04-14T02:20:00Z",
-                    "count": 0.0
+                    "timeStamp": "2021-04-16T01:00:00Z",
+                    "average": 0.0,
+                    "minimum": 0.0,
+                    "maximum": 0.0
+                  },
+                  {
+                    "timeStamp": "2021-04-16T07:00:00Z",
+                    "average": 0.0,
+                    "minimum": 0.0,
+                    "maximum": 0.0
                   },
                   {
-                    "timeStamp": "2017-04-14T02:21:00Z",
-                    "count": 0.0
+                    "timeStamp": "2021-04-16T13:00:00Z",
+                    "average": 0.0,
+                    "minimum": 0.0,
+                    "maximum": 0.0
                   },
                   {
-                    "timeStamp": "2017-04-14T02:22:00Z",
-                    "count": 0.0
+                    "timeStamp": "2021-04-16T19:00:00Z",
+                    "average": 0.0,
+                    "minimum": 0.0,
+                    "maximum": 0.0
                   },
                   {
-                    "timeStamp": "2017-04-14T02:23:00Z",
-                    "count": 1.0,
-                    "average": 0.0
+                    "timeStamp": "2021-04-17T01:00:00Z",
+                    "average": 0.0,
+                    "minimum": 0.0,
+                    "maximum": 0.0
                   }
                 ]
               },
@@ -63,30 +120,44 @@
                       "value": "blobtype",
                       "localizedValue": "blobtype"
                     },
-                    "value": "BlockBlob"
+                    "value": "Azure Data Lake Storage"
                   }
                 ],
                 "data": [
                   {
-                    "timeStamp": "2017-04-14T02:20:00Z",
-                    "count": 0.0
+                    "timeStamp": "2021-04-16T01:00:00Z",
+                    "average": 0.0,
+                    "minimum": 0.0,
+                    "maximum": 0.0
+                  },
+                  {
+                    "timeStamp": "2021-04-16T07:00:00Z",
+                    "average": 0.0,
+                    "minimum": 0.0,
+                    "maximum": 0.0
                   },
                   {
-                    "timeStamp": "2017-04-14T02:21:00Z",
-                    "count": 0.0
+                    "timeStamp": "2021-04-16T13:00:00Z",
+                    "average": 0.0,
+                    "minimum": 0.0,
+                    "maximum": 0.0
                   },
                   {
-                    "timeStamp": "2017-04-14T02:22:00Z",
-                    "count": 0.0
+                    "timeStamp": "2021-04-16T19:00:00Z",
+                    "average": 0.0,
+                    "minimum": 0.0,
+                    "maximum": 0.0
                   },
                   {
-                    "timeStamp": "2017-04-14T02:23:00Z",
-                    "count": 1.0,
-                    "average": 245.0
+                    "timeStamp": "2021-04-17T01:00:00Z",
+                    "average": 0.0,
+                    "minimum": 0.0,
+                    "maximum": 0.0
                   }
                 ]
               }
-            ]
+            ],
+            "errorCode": "Success"
           }
         ]
       }

diff --git a/...rce-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/GetMetricMetadata.json b/...rce-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/GetMetricMetadata.json
@@ -1,29 +1,27 @@
 {
   "parameters": {
-    "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z",
-    "metric": "BlobCapacity",
+    "timespan": "2021-04-18T22:14:26.647Z/2021-04-19T22:14:26.647Z",
+    "metric": "BlobCount",
     "$filter": "BlobType eq '*'",
-    "top": "3",
-    "orderby": "Average asc",
-    "aggregation": "Average,count",
-    "interval": "PT1M",
     "resulttype": "metadata",
-    "resourceUri": "subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default",
+    "resourceUri": "subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default",
     "api-version": "2017-05-01-preview"
   },
   "responses": {
     "200": {
       "body": {
-        "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z",
+        "timespan": "2021-04-18T22:14:26Z/2021-04-19T22:14:26Z",
+        "interval": "PT1H",
         "value": [
           {
-            "id": "/subscriptions/b324c52b-4073-4807-93af-e07d289c093e/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/larryshoebox/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity",
+            "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount",
             "type": "Microsoft.Insights/metrics",
             "name": {
-              "value": "BlobCapacity",
-              "localizedValue": "Blob Capacity"
+              "value": "BlobCount",
+              "localizedValue": "Blob Count"
             },
-            "unit": "Bytes",
+            "displayDescription": "The number of blob objects stored in the storage account.",
+            "unit": "Count",
             "timeseries": [
               {
                 "metadatavalues": [
@@ -46,6 +44,17 @@
                     "value": "PageBlob"
                   }
                 ]
+              },
+              {
+                "metadatavalues": [
+                  {
+                    "name": {
+                      "value": "blobtype",
+                      "localizedValue": "blobtype"
+                    },
+                    "value": "Azure Data Lake Storage"
+                  }
+                ]
               }
             ]
           }

diff --git a/...resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json b/...resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json
@@ -197,7 +197,7 @@
     },
     "Unit": {
       "type": "string",
-      "description": "the unit of the metric.",
+      "description": "The unit of the metric.",
       "enum": [
         "Count",
         "Bytes",
@@ -207,7 +207,11 @@
         "Percent",
         "MilliSeconds",
         "ByteSeconds",
-        "Unspecified"
+        "Unspecified",
+        "Cores",
+        "MilliCores",
+        "NanoCores",
+        "BitsPerSecond"
       ],
       "x-ms-enum": {
         "name": "Unit",
@@ -228,6 +232,14 @@
           "$ref": "#/definitions/LocalizableString",
           "description": "the name and the display name of the metric, i.e. it is a localizable string."
         },
+        "displayDescription": {
+          "type": "string",
+          "description": "Detailed description of this metric."
+        },
+        "category": {
+          "type": "string",
+          "description": "Custom category name for this metric."
+        },
         "unit": {
           "$ref": "#/definitions/Unit",
           "description": "the unit of the metric."

diff --git a/...n/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json b/...n/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json
@@ -104,6 +104,7 @@
                       "value": "CpuTime",
                       "localizedValue": "CPU Time"
                     },
+                    "displayDescription": "CPU Time",
                     "unit": "Seconds",
                     "timeseries": [
                       {
@@ -177,7 +178,7 @@
     },
     "Unit": {
       "type": "string",
-      "description": "the unit of the metric.",
+      "description": "The unit of the metric.",
       "enum": [
         "Count",
         "Bytes",
@@ -187,7 +188,11 @@
         "Percent",
         "MilliSeconds",
         "ByteSeconds",
-        "Unspecified"
+        "Unspecified",
+        "Cores",
+        "MilliCores",
+        "NanoCores",
+        "BitsPerSecond"
       ],
       "x-ms-enum": {
         "name": "Unit",
@@ -266,7 +271,7 @@
           "type": "number",
           "format": "int32",
           "minimum": 0,
-          "description": "The integer value representing the cost of the query, for data case."
+          "description": "The integer value representing the relative cost of the query."
         },
         "timespan": {
           "type": "string",
@@ -306,6 +311,14 @@
           "$ref": "#/definitions/LocalizableString",
           "description": "the name and the display name of the metric, i.e. it is localizable string."
         },
+        "displayDescription": {
+          "type": "string",
+          "description": "Detailed description of this metric."
+        },
+        "errorCode": {
+          "type": "string",
+          "description": "'Success' or the error details on query failures for this metric."
+        },
         "unit": {
           "$ref": "#/definitions/Unit",
           "description": "the unit of the metric."
@@ -322,6 +335,7 @@
         "id",
         "type",
         "name",
+        "displayDescription",
         "unit",
         "timeseries"
       ],

diff --git a/...e-manager/Microsoft.Insights/preview/2017-12-01-preview/examples/GetMetricNamespaces.json b/...e-manager/Microsoft.Insights/preview/2017-12-01-preview/examples/GetMetricNamespaces.json
@@ -1,19 +1,29 @@
 {
   "parameters": {
-    "resourceUri": "subscriptions/a252e87d-ec06-45b1-8901-57e613be91b0/resourceGroups/larrytest/providers/Microsoft.DocumentDB/databaseAccounts/larrytestdocdb",
-    "startTime": "2018-08-31T15:53:00Z",
+    "resourceUri": "subscriptions/182c901a-129a-4f5d-86e4-cc6b294590a2/resourceGroups/hyr-log/providers/microsoft.insights/components/f1-bill",
+    "startTime": "2020-08-31T15:53:00Z",
     "api-version": "2017-12-01-preview"
   },
   "responses": {
     "200": {
       "body": {
         "value": [
           {
-            "id": "/subscriptions/a252e87d-ec06-45b1-8901-57e613be91b0/resourceGroups/larrytest/providers/Microsoft.DocumentDB/databaseAccounts/larrytestdocdb/providers/microsoft.insights/metricNamespaces/Microsoft.DocumentDB-databaseAccounts",
-            "name": "Microsoft.DocumentDB-databaseAccounts",
+            "id": "/subscriptions/182c901a-129a-4f5d-86e4-cc6b294590a2/resourceGroups/hyr-log/providers/microsoft.insights/components/f1-bill/providers/microsoft.insights/metricNamespaces/Azure.ApplicationInsights",
+            "name": "Azure.ApplicationInsights",
             "type": "Microsoft.Insights/metricNamespaces",
+            "classification": "Custom",
             "properties": {
-              "metricNamespaceName": "Microsoft.DocumentDB/databaseAccounts"
+              "metricNamespaceName": "Azure.ApplicationInsights"
+            }
+          },
+          {
+            "id": "/subscriptions/182c901a-129a-4f5d-86e4-cc6b294590a2/resourceGroups/hyr-log/providers/microsoft.insights/components/f1-bill/providers/microsoft.insights/metricNamespaces/microsoft.insights-components",
+            "name": "microsoft.insights-components",
+            "type": "Microsoft.Insights/metricNamespaces",
+            "classification": "Platform",
+            "properties": {
+              "metricNamespaceName": "microsoft.insights/components"
             }
           }
         ]