API-интерфейсы отчетов для корпоративных клиентов: баланс и сводка
Примечание
1 мая 2024 г. поддержка API-интерфейсов azure Enterprise Reporting будет прекращена. Все оставшиеся API-интерфейсы корпоративной отчетности перестанут отвечать на запросы. До этого клиентам необходимо перейти на api управления затратами Майкрософт. Дополнительные сведения см. в статье Переход с интерфейсов API для корпоративной отчетности на API Управления затратами Майкрософт.
API-интерфейс для управления балансом предоставляет ежемесячную сводку о состоянии баланса, новых покупках, расходах на службы Azure Marketplace, корректировках и взимании платы за превышение.
Запрос
Общие свойства заголовка, которые необходимо добавить, перечислены в статье с обзором API-интерфейсов отчетов для корпоративных клиентов. Если расчетный период не указан, возвращаются данные за текущий расчетный период.
| Метод | Универсальный код ресурса (URI) запроса |
|---|---|
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/balancesummary |
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/billingPeriods/{billingPeriod}/balancesummary |
Примечание
Чтобы использовать предыдущую версию API, замените версию 3 на версию 2 в URL-адресах выше. Некоторые поля недоступны при использовании версии 2.
Ответ
{
"id": "enrollments/100/billingperiods/201507/balancesummaries",
"billingPeriodId": 201507,
"currencyCode": "USD",
"beginningBalance": 0,
"endingBalance": 1.1,
"newPurchases": 1,
"adjustments": 1.1,
"utilized": 1.1,
"serviceOverage": 1,
"chargesBilledSeparately": 1,
"totalOverage": 1,
"totalUsage": 1.1,
"azureMarketplaceServiceCharges": 1,
"newPurchasesDetails": [
{
"name": "",
"value": 1
}
],
"adjustmentDetails": [
{
"name": "Promo Credit",
"value": 1.1
},
{
"name": "SIE Credit",
"value": 1.0
}
]
}
Определения свойств ответа
| Имя свойства | Тип | Описание |
|---|---|---|
| идентификатор | строка | Уникальный идентификатор для определенного расчетного периода и регистрации |
| billingPeriodId | строка | Идентификатор расчетного периода |
| currencyCode | строка | Код валюты |
| beginningBalance | Decimal | Начальный баланс для расчетного периода |
| endingBalance | Decimal | Конечное сальдо для расчетного периода (для открытых периодов это значение обновляется ежедневно) |
| newPurchases | Decimal | Общая сумма новой покупки |
| adjustments | Decimal | Общая сумма корректировки |
| utilized | Decimal | Общая сумма обязательств |
| serviceOverage | Decimal | Превышение использования служб Azure |
| chargesBilledSeparately | Decimal | Счета, выставляемые отдельно |
| totalOverage | Decimal | serviceOverage + chargesBilledSeparately |
| totalUsage | Decimal | Обязательства по службам Azure + totalOverage |
| azureMarketplaceServiceCharges | Decimal | Общая сумма платежей за использование Azure Marketplace |
| newPurchasesDetails | Массив строк JSON из пар "имя-значение" | Список новых покупок |
| adjustmentDetails | Массив строк JSON из пар "имя-значение" | Список корректировок (акционный кредит, кредит SIE и т. д.) |