Adding BillingMeters API (#2745)

* Adding BillingMeters API
Azure · Mar 30, 2018 · 47d267f · 47d267f
1 parent 83c74ca
commit 47d267f
Show file tree

Hide file tree

Showing 2 changed files with 115 additions and 0 deletions.
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json
@@ -179,6 +179,38 @@
         }
       }
     },
+    "/subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters": {
+      "get": {
+        "summary": "Gets a list of meters for a given location.",
+        "description": "Gets a list of meters for a given location.",
+        "operationId": "BillingMeters_List",
+        "parameters": [
+          {
+            "name": "billingLocation",
+            "in": "query",
+            "description": "Azure Location of billable resource",
+            "type": "string"
+          },
+          {
+            "$ref": "#/parameters/subscriptionIdParameter"
+          },
+          {
+            "$ref": "#/parameters/apiVersionParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/BillingMeterCollection"
+            }
+          }
+        },
+        "x-ms-pageable": {
+          "nextLinkName": "nextLink"
+        }
+      }
+    },
     "/subscriptions/{subscriptionId}/providers/Microsoft.Web/deploymentLocations": {
       "get": {
         "summary": "Gets list of available geo regions plus ministamps",
@@ -476,6 +508,64 @@
     }
   },
   "definitions": {
+    "BillingMeter": {
+      "description": "App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services.",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+        }
+      ],
+      "properties": {
+        "properties": {
+          "description": "BillingMeter resource specific properties",
+          "properties": {
+            "meterId": {
+              "description": "Meter GUID onboarded in Commerce",
+              "type": "string"
+            },
+            "billingLocation": {
+              "description": "Azure Location of billable resource",
+              "type": "string"
+            },
+            "shortName": {
+              "description": "Short Name from App Service Azure pricing Page",
+              "type": "string"
+            },
+            "friendlyName": {
+              "description": "Friendly name of the meter",
+              "type": "string"
+            },
+            "resourceType": {
+              "description": "App Service resource type meter used for",
+              "type": "string"
+            }
+          },
+          "x-ms-client-flatten": true
+        }
+      }
+    },
+    "BillingMeterCollection": {
+      "description": "Collection of Billing Meters",
+      "required": [
+        "value"
+      ],
+      "type": "object",
+      "properties": {
+        "value": {
+          "description": "Collection of Billing Meters.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/BillingMeter"
+          }
+        },
+        "nextLink": {
+          "description": "Link to next page of resources.",
+          "type": "string",
+          "readOnly": true
+        }
+      }
+    },
     "CsmMoveResourceEnvelope": {
       "description": "Object with a list of the resources that need to be moved and the resource group they should be moved to.",
       "type": "object",

diff --git a/...tion/web/resource-manager/Microsoft.Web/stable/2016-03-01/examples/ListBillingMeters.json b/...tion/web/resource-manager/Microsoft.Web/stable/2016-03-01/examples/ListBillingMeters.json
@@ -0,0 +1,25 @@
+{
+  "parameters": {
+    "subscriptionId": "{subId}",
+    "api-version": "2016-03-01"
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "value": {
+          "id": "subscriptions/{subId}/providers/Microsoft.Web/billingMeters/{meterId}",
+          "name": "{meterId}",
+          "type": "subscriptions/{subId}/providers/Microsoft.Web/billingMeters",
+          "properties": {
+            "meterId": "{meterId}",
+            "billingLocation": "southcentralus",
+            "shortName": "I3",
+            "friendlyName": "Isolated Large App Service Hours",
+            "resourceType": "serverfarm"
+          }
+        }
+      }
+    }
+  }
+}