From 647dccb1bb2a0a045c88daea512d520a557b9f24 Mon Sep 17 00:00:00 2001 From: maddieminn <79888413+maddieminn@users.noreply.github.com> Date: Mon, 7 Jun 2021 18:37:27 -0600 Subject: [PATCH] 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 --- .../stable/2019-10-01/consumption.json | 6 +++--- .../ReservationSummariesMonthlyWithBillingAccountId.json | 3 ++- .../ReservationSummariesMonthlyWithBillingProfileId.json | 4 +++- ...onSummariesMonthlyWithBillingProfileIdReservationId.json | 2 ++ 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json index c566b00a8d9a..c6a19e934001 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json @@ -812,7 +812,7 @@ { "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" @@ -820,14 +820,14 @@ { "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/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json index e301b98fe19f..ef4d890884ca 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/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/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json index 72ecb47a78d1..97b7fc49aeb3 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/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/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json index 4d7621b008d8..339ca77aff63 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/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" },