EA Balance Summary API からの移行

  • [アーティクル]

以前に Enterprise Reporting consumption.azure.com API を使用して残高の概要を取得していた EA のお客様は、代わりの Azure Resource Manager API に移行する必要があります。 次の手順は、古い API と新しい API の間のコントラクトの違いを移行して説明するのに役立ちます。

Note

すべての Azure Enterprise Reporting API は廃止されます。 できるだけ早く Microsoft Cost Management API に移行する必要があります。

API を呼び出すアクセス許可をサービス プリンシパルに割り当てる

API を呼び出す前に、適切なアクセス許可を持つサービス プリンシパルを構成する必要があります。 サービス プリンシパルを使用して API を呼び出します。 詳細については、「Cost Management API へのアクセス許可の割り当て」を参照してください。

Balance Summary API の呼び出し

新しい Balance Summary API を呼び出す際は、以下の要求 URI を使用します。 billingAccountId には、実際の加入契約番号を使用する必要があります。

サポートされている要求

加入契約を対象に取得する

https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances?api-version=2023-05-01

応答本文の変更

以前の応答本文:

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

新しい応答本文:

同じデータは、新しい API 応答のプロパティ フィールドから取得できます。 一部のフィールド名は、スペルが若干変更されている可能性があります。

{
  "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/balances/balanceId1",
  "name": "balanceId1",
  "type": "Microsoft.Consumption/balances",
  "properties": {
    "currency": "USD  ",
    "beginningBalance": 3396469.19,
    "endingBalance": 2922371.02,
    "newPurchases": 0,
    "adjustments": 0,
    "utilized": 474098.17,
    "serviceOverage": 0,
    "chargesBilledSeparately": 0,
    "totalOverage": 0,
    "totalUsage": 474098.17,
    "azureMarketplaceServiceCharges": 609.82,
    "billingFrequency": "Month",
    "priceHidden": false,
    "overageRefund": 2012.61,
    "newPurchasesDetails": [
      {
        "name": "Promo Purchase",
        "value": 1
      }
    ],
    "adjustmentDetails": [
      {
        "name": "Promo Credit",
        "value": 1.1
      },
      {
        "name": "SIE Credit",
        "value": 1
      }
    ]
  }
}

関連するコンテンツ