Update Parameters Documentation for Reservation Summaries API (#14453)

* updated specs for reservation summaries billing account / billing profile scope to require usageDate and start/end date * change "required" back to false and update descriptions
Azure · Jun 8, 2021 · a71207a · a71207a
1 parent 10c93ad
commit a71207a
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/...ion/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json b/...ion/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json
@@ -812,22 +812,22 @@
           {
             "name": "startDate",
             "in": "query",
-            "description": "Start date. Only applicable when querying with billing profile",
+            "description": "Start date. Required only when querying with billing profile",
             "required": false,
             "type": "string",
             "x-ms-parameter-location": "method"
           },
           {
             "name": "endDate",
             "in": "query",
-            "description": "End date. Only applicable when querying with billing profile",
+            "description": "End date. Required only when querying with billing profile",
             "required": false,
             "type": "string",
             "x-ms-parameter-location": "method"
           },
           {
             "name": "$filter",
-            "description": "Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and  'ge'. Not applicable when querying with billing profile",
+            "description": "The properties/UsageDate for start date and end date. The filter supports 'le' and  'ge'. Not required when querying with billing profile",
             "in": "query",
             "required": false,
             "type": "string"

diff --git a/...nsumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json b/...nsumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json
@@ -2,7 +2,8 @@
   "parameters": {
     "api-version": "2019-10-01",
     "scope": "providers/Microsoft.Billing/billingAccounts/12345",
-    "grain": "monthly"
+    "grain": "monthly",
+    "$filter": "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20"
   },
   "responses": {
     "200": {

diff --git a/...nsumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json b/...nsumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json
@@ -2,7 +2,9 @@
   "parameters": {
     "api-version": "2019-10-01",
     "scope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579",
-    "grain": "monthly"
+    "grain": "monthly",
+    "startDate": "2017-10-01",
+    "endDate": "2017-11-20"
   },
   "responses": {
     "200": {

diff --git a/...ble/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json b/...ble/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json
@@ -3,6 +3,8 @@
     "api-version": "2019-10-01",
     "scope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579",
     "grain": "monthly",
+    "startDate": "2017-10-01",
+    "endDate": "2017-11-20",
     "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
     "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc"
   },