Skip to content

Commit a71207a

Browse files
authored
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
1 parent 10c93ad commit a71207a

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -812,22 +812,22 @@
812812
{
813813
"name": "startDate",
814814
"in": "query",
815-
"description": "Start date. Only applicable when querying with billing profile",
815+
"description": "Start date. Required only when querying with billing profile",
816816
"required": false,
817817
"type": "string",
818818
"x-ms-parameter-location": "method"
819819
},
820820
{
821821
"name": "endDate",
822822
"in": "query",
823-
"description": "End date. Only applicable when querying with billing profile",
823+
"description": "End date. Required only when querying with billing profile",
824824
"required": false,
825825
"type": "string",
826826
"x-ms-parameter-location": "method"
827827
},
828828
{
829829
"name": "$filter",
830-
"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",
830+
"description": "The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. Not required when querying with billing profile",
831831
"in": "query",
832832
"required": false,
833833
"type": "string"

specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingAccountId.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"parameters": {
33
"api-version": "2019-10-01",
44
"scope": "providers/Microsoft.Billing/billingAccounts/12345",
5-
"grain": "monthly"
5+
"grain": "monthly",
6+
"$filter": "properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20"
67
},
78
"responses": {
89
"200": {

specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileId.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
"parameters": {
33
"api-version": "2019-10-01",
44
"scope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579",
5-
"grain": "monthly"
5+
"grain": "monthly",
6+
"startDate": "2017-10-01",
7+
"endDate": "2017-11-20"
68
},
79
"responses": {
810
"200": {

specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
"api-version": "2019-10-01",
44
"scope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579",
55
"grain": "monthly",
6+
"startDate": "2017-10-01",
7+
"endDate": "2017-11-20",
68
"reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
79
"reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc"
810
},

0 commit comments

Comments
 (0)