企業ユーザー向けの Reporting API - 残高とサマリー

注意

2024 年 5 月 1 日に、Azure Enterprise Reporting API は廃止されます。 残りのエンタープライズ レポート API は、要求への応答を停止します。 お客様は、その前に Microsoft Cost Management API の使用に移行する必要があります。 詳細については、 Azure Enterprise Reporting から Microsoft Cost Management API への移行の概要に関するページを参照してください。

Balance and Summary API を使用すると、残高、新規購入、Azure Marketplace サービス料金、調整、および超過料金に関する情報の月別サマリーが提供されます。

要求

追加する必要がある一般的なヘッダー プロパティについては、Enterprise 顧客向けの Reporting API の概要に関する記事をご覧ください。 請求期間が指定されていない場合は、現在の請求期間のデータが返されます。

Method 要求 URI
GET https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/balancesummary
GET https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/billingPeriods/{billingPeriod}/balancesummary

注意

以前のバージョンの API を使用するには、上記の URL で v3 を v2 に置き換えます。 v2 を使用する場合、一部のフィールドは使用できません。

Response

        {
            "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
                }
              ]
        }

応答プロパティの定義

プロパティ名 Type 説明
id string 特定の請求期間と加入契約に対する一意の ID
billingPeriodId string 請求期間 ID
currencyCode string 通貨コード
beginningBalance decimal 請求期間の期首残高
endingBalance decimal 請求期間の期末残高 (オープン期間の場合は毎日更新されます)
newPurchases decimal 新規購入額の合計
adjustments decimal 調整額の合計
utilized decimal コミットメントの合計使用率
serviceOverage decimal Azure サービスの超過料金
chargesBilledSeparately decimal 別途料金請求
totalOverage decimal serviceOverage と chargesBilledSeparately の合計
totalUsage decimal Azure サービス コミットメント と 超過料金総額の合計
azureMarketplaceServiceCharges decimal Azure Marketplace の請求額合計
newPurchasesDetails 名前値ペアの JSON 文字列配列 新規購入の一覧
adjustmentDetails 名前値ペアの JSON 文字列配列 調整 (プロモーション クレジット、SIE クレジットなど) の一覧

こちらもご覧ください