Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updated for Lots, Events and Credits #14314

Merged
merged 6 commits into from
May 31, 2021
Merged

Documentation updated for Lots, Events and Credits #14314

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4afe5f4
Documentation updated for Lots, Events and Credits
edgarvazquez23 May 7, 2021
ee27472
Fixing PR comments
edgarvazquez23 May 7, 2021
54b781d
Fixed PR comments.
edgarvazquez23 May 10, 2021
f25bae7
Fixed Events examples
edgarvazquez23 May 11, 2021
11fe79c
Fixing pipeline
edgarvazquez23 May 24, 2021
505447c
Fixing pipeline
edgarvazquez23 May 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 120 additions & 0 deletions ...ion/consumption/resource-manager/Microsoft.Consumption/stable/2021-05-01/consumption.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4933,16 +4933,41 @@
"type": "string",
"readOnly": true
},
"creditCurrency": {
"description": "The credit currency of the event.",
"type": "string",
"readOnly": true
},
"billingCurrency": {
"description": "The billing currency of the event.",
"type": "string",
"readOnly": true
},
"reseller": {
"description": "The reseller of the event.",
"readOnly": true,
"$ref": "#/definitions/Reseller"
},
"newCredit": {
"description": "The amount of new credit or commitment for NewCredit or SettleCharges event.",
"readOnly": true,
"$ref": "#/definitions/amount"
},
"newCreditInBillingCurrency": {
"description": "The amount of new credit or commitment for NewCredit or SettleCharges event in billing currency.",
"readOnly": true,
"$ref": "#/definitions/AmountWithExchangeRate"
},
"adjustments": {
"description": "The amount of balance adjustment. The property is not available for ConsumptionCommitment lots.",
"readOnly": true,
"$ref": "#/definitions/amount"
},
"adjustmentsInBillingCurrency": {
"description": "The amount of balance adjustment in billing currency.",
"readOnly": true,
"$ref": "#/definitions/AmountWithExchangeRate"
},
"creditExpired": {
"description": "The amount of expired credit or commitment for NewCredit or SettleCharges event.",
"readOnly": true,
Expand All @@ -4953,11 +4978,21 @@
"readOnly": true,
"$ref": "#/definitions/amount"
},
"chargesInBillingCurrency": {
"description": "The amount of charges for events of type SettleCharges and PendingEligibleCharges in billing currency.",
"readOnly": true,
"$ref": "#/definitions/AmountWithExchangeRate"
},
"closedBalance": {
"description": "The balance after the event. ",
"readOnly": true,
"$ref": "#/definitions/amount"
},
"closedBalanceInBillingCurrency": {
"description": "The balance in billing currency after the event.",
"readOnly": true,
"$ref": "#/definitions/AmountWithExchangeRate"
},
"eventType": {
"description": "Identifies the type of the event.",
"type": "string",
Expand Down Expand Up @@ -4999,6 +5034,11 @@
"description": "Identifies the source of the lot for which the event happened. ",
"type": "string",
"readOnly": true
},
"canceledCredit": {
"description": "Amount of canceled credit.",
"readOnly": true,
"$ref": "#/definitions/Amount"
}
}
},
Expand Down Expand Up @@ -5039,16 +5079,41 @@
"LotProperties": {
"description": "The lot properties.",
"properties": {
"creditCurrency": {
"description": "The currency of the lot.",
"type": "string",
"readOnly": true
},
"billingCurrency": {
"description": "The billing currency of the lot.",
"type": "string",
"readOnly": true
},
"originalAmount": {
"description": "The original amount of a lot.",
"readOnly": true,
"$ref": "#/definitions/amount"
},
"originalAmountInBillingCurrency": {
"description": "The original amount of a lot in billing currency.",
"readOnly": true,
"$ref": "#/definitions/AmountWithExchangeRate"
},
"closedBalance": {
"description": "The balance as of the last invoice.",
"readOnly": true,
"$ref": "#/definitions/amount"
},
"closedBalanceInBillingCurrency": {
"description": "The balance as of the last invoice in billing currency.",
"readOnly": true,
"$ref": "#/definitions/AmountWithExchangeRate"
},
"reseller": {
"description": "The reseller of the lot.",
"readOnly": true,
"$ref": "#/definitions/Reseller"
},
"source": {
"description": "The source of the lot.",
"type": "string",
Expand Down Expand Up @@ -5089,6 +5154,14 @@
"status": {
"description": "The status of the lot.",
"type": "string",
"enum": [
"None",
"Active",
"Inactive",
"Expired",
"Complete",
"Canceled"
],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The following needs to be added

"x-ms-enum": {
"name": "Status",
"modelAsString": true
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

"readOnly": true
}
}
Expand All @@ -5113,6 +5186,16 @@
"description": "The properties of the credit summary.",
"type": "object",
"properties": {
"creditCurrency": {
"description": "The credit currency.",
"type": "string",
"readOnly": true
},
"billingCurrency": {
"description": "The billing currency.",
"type": "string",
"readOnly": true
},
"balanceSummary": {
"description": "Summary of balances associated with this credit summary.",
"readOnly": true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CreditBalanceSummary definition is missing "EstimatedBalanceInBillingCurrency"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

Expand All @@ -5132,6 +5215,11 @@
"description": "Pending eligible charges.",
"readOnly": true,
"$ref": "#/definitions/amount"
},
"reseller": {
"description": "Reseller.",
"readOnly": true,
"$ref": "#/definitions/Reseller"
}
}
},
Expand Down Expand Up @@ -5166,6 +5254,38 @@
}
}
},
"AmountWithExchangeRate": {
"description": "The amount with exchange rate.",
"type": "object",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

type would not be needed here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.

"properties": {
"exchangeRate": {
"description": "The exchange rate.",
"type": "decimal",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"type": "number", "format": "decimal",

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

"readOnly": true
},
"exchangeRateMonth": {
"description": "The exchange rate month.",
"type": "int",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"type": "integer", "format": "int32",

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

"readOnly": true
}
}
},
"Reseller": {
"description": "The reseller properties.",
"type": "object",
"properties": {
"resellerId": {
"description": "The reseller property ID.",
"type": "string",
"readOnly": true
},
"resellerDescription": {
"description": "The reseller property description.",
"type": "string",
"readOnly": true
}
}
},
"Resource": {
"description": "The Resource model definition.",
"properties": {
Expand Down
6 changes: 6 additions & 0 deletions ...nager/Microsoft.Consumption/stable/2021-05-01/examples/CreditSummaryByBillingProfile.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
"name": "balanceSummary1",
"type": "Microsoft.Consumption/credits/balanceSummary",
"properties": {
"creditCurrency": "USD",
"billingCurrency": "USD",
"balanceSummary": {
"estimatedBalance": {
"currency": "USD",
Expand All @@ -32,6 +34,10 @@
"pendingEligibleCharges": {
"currency": "USD",
"value": 0.00
},
"reseller": {
"resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1",
"resellerDescription": 1
}
}
}
Expand Down
82 changes: 80 additions & 2 deletions ...e-manager/Microsoft.Consumption/stable/2021-05-01/examples/EventsGetByBillingAccount.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,32 @@
"name": "eventId1",
"type": "Microsoft.Consumption/events",
"properties": {
"creditCurrency": "USD",
"billingCurrency": "USD",
"reseller": {
"resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1",
"resellerDescription": 1
},
"newCredit": {
"currency": "USD",
"value": 500
},
"newCreditInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"adjustments": {
"currency": "USD",
"value": 100
},
"adjustmentsInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"creditExpired": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be canceledCredit.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed.

"currency": "USD",
"value": 200
},
"lotSource": "ConsumptionCommitment",
"lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/G202001083926600XXXXX",
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB",
Expand All @@ -22,18 +48,57 @@
"currency": "USD",
"value": 500
},
"chargesInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"closedBalance": {
"currency": "USD",
"value": 500
},
"invoiceNumber": "3304"
"closedBalanceInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"eventType": "PendingCharges",
"invoiceNumber": "3304",
"canceledCredit": {
"currency": "USD",
"value": 5000
}
}
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/1234:56789/providers/Microsoft.Consumption/events/eventId2",
"name": "eventId2",
"type": "Microsoft.Consumption/events",
"properties": {
"creditCurrency": "USD",
"billingCurrency": "USD",
"reseller": {
"resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1",
"resellerDescription": 1
},
"newCredit": {
"currency": "USD",
"value": 500
},
"newCreditInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"adjustments": {
"currency": "USD",
"value": 100
},
"adjustmentsInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"creditExpired": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above. This should be canceledCredit.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed.

"currency": "USD",
"value": 200
},
"lotSource": "AzurePrepayment",
"lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/7004bc39-974d-482e-8e45-caf91dba0870",
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB",
Expand All @@ -44,11 +109,24 @@
"currency": "USD",
"value": 500
},
"chargesInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"closedBalance": {
"currency": "USD",
"value": 500
},
"invoiceNumber": "3304"
"closedBalanceInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"eventType": "PendingCharges",
"invoiceNumber": "3304",
"canceledCredit": {
"currency": "USD",
"value": 5000
}
}
}
]
Expand Down
41 changes: 40 additions & 1 deletion ...icrosoft.Consumption/stable/2021-05-01/examples/EventsGetByBillingAccountWithFilters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,32 @@
"name": "eventId1",
"type": "Microsoft.Consumption/events",
"properties": {
"creditCurrency": "USD",
"billingCurrency": "USD",
"reseller": {
"resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1",
"resellerDescription": 1
},
"newCredit": {
"currency": "USD",
"value": 500
},
"newCreditInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"adjustments": {
"currency": "USD",
"value": 100
},
"adjustmentsInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"creditExpired": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be canceledCredit.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed.

"currency": "USD",
"value": 200
},
"lotSource": "ConsumptionCommitment",
"lotId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/Microsoft.Consumption/lots/G202001083926600XXXXX",
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/X3TD-KVTT-BG7-TGB",
Expand All @@ -23,11 +49,24 @@
"currency": "USD",
"value": 500
},
"chargesInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"closedBalance": {
"currency": "USD",
"value": 500
},
"invoiceNumber": "3304"
"closedBalanceInBillingCurrency": {
"exchangeRate": 5000.00,
"exchangeRateMonth": 1
},
"eventType": "PendingCharges",
"invoiceNumber": "3304",
"canceledCredit": {
"currency": "USD",
"value": 5000
}
}
}
]
Expand Down
Loading