Azure Consumption

[アーティクル]
02/07/2024

Azure Consumption API シリーズを使用すると、Azure リソースのコストおよび使用状況データにプログラムでアクセスできます。現在、API では、Enterprise Enrollments、Web Direct サブスクリプション (いくつかの例外を除く)、CSP Azure プランサブスクリプションのみがサポートされています。 API は、他の種類の Azure サブスクリプションをサポートするために継続的に更新されます。

Azure Consumption API シリーズでは、以下にアクセスできます。

Enterprise のお客様のみ
- Price Sheet
- Budgets
- Forecasts
- Balances
- タグ
- Cost Tags
Enterprise および Web Direct のお客様
- Reservation Details
- Reservation Summaries
- Marketplace Charges
- Usage Details
- Reservation Recommendations

サポートされていないサブスクリプションの種類の一覧

MS-AZR-0145P (CSP)
MS-AZR-0146P (CSP)
MS-AZR-159P (CSP)
MS-AZR-0036P (スポンサー付き)
MS-AZR-0143P (スポンサー付き)
MS-AZR-0015P (内部)
MS-AZR-0144P (DreamSpark)

請求期間と日付範囲の操作

使用状況の詳細と Marketplace の料金は、使用状況データの開始日と終了日を定義するための請求期間または日付範囲を受け入れます。

要求の請求期間と日付範囲に基づく API の動作を次に示します。

要求に存在する請求期間	要求に存在する開始日	要求に存在する終了日	API の動作
no	no	no	現在の請求期間のデータが応答で返される
no	はい	no	現在の請求期間のデータが応答で返される
no	no	はい	現在の請求期間のデータが応答で返される
no	はい	はい	指定した開始日と終了日のデータが応答で返されます
はい	no	no	指定された請求期間のデータが応答で返されます
はい	はい	no	指定された請求期間のデータが応答で返されます
はい	no	はい	指定された請求期間のデータが応答で返されます
はい	はい	はい	指定した開始日と終了日のデータが応答で返され、指定された請求期間は無視されます

1 つの要求で許容される最大日付範囲は 12 か月で、データは 2014 年 5 月 1 日以降に使用できます。

請求期間の一覧を取得する

要求で有効な請求期間を指定するために、クライアントはまず、次の API を使用して、サブスクリプション別に利用可能な請求期間の一覧を取得する必要があります

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods?api-version=2017-04-24-preview

この一覧を使用して、クライアントは特定の請求期間を選択して消費データを取得できます。

遅延到着データ

使用状況の報告に遅延があるサードパーティのサービスに対応するために、報告される使用日は、実際の使用状況が発生した日時ではなく、使用状況データが送信された時刻に設定されます。

その結果、使用状況が評価され、報告された時間に適用されます。実際の消費時間を表すために、 プロパティ。AdditionalProperties フィールドに 2 つの追加プロパティが含まれるようになりました。 ConsumptionBeginTime と ConsumptionEndTime は、実際の消費時間枠に対応する新しいフィールドです。

これらの変更により、使用状況の詳細 API を呼び出すときに対処する必要があるシナリオがいくつかあります。

月の終了レポート: 1 か月中に発生したが、翌月に報告された使用状況の場合、顧客は追加の [プロパティ ] フィールドを確認して使用状況を適切な月に割り当てる必要があります。
クエリの使用状況の詳細: 使用状況の詳細 API に日付範囲でクエリを実行する場合、クエリは、 additionalProperties フィールドの使用時間ではなく、使用状況レポートの日付にのみ適用されます。使用状況の詳細を請求書にマップしようとしているお客様の場合、この更新プログラムは、請求書が使用状況レポートの日付に基づいて使用状況を処理するため、プロセスには影響しません。使用の詳細を特定のカレンダーの日付/月にマップする場合、この更新プログラムは破壊的変更であり、これらのシナリオでは使用状況レポートの日付を使用できず、使用が発生した日付を additionalProperties セクションで使用する必要があります。

追加の詳細のサンプル呼び出し:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails?api-version=2018-03-31&$expand=properties/additionalProperties

応答スニペットの例:

  "properties": {
    "billingPeriodId":"/subscriptions/{subscriptionid}/providers/Microsoft.Billing/billingPeriods/20180501",
    "usageStart":"2018-05-01T00:00:00.0000000Z",
    "usageEnd":"2018-05-01T23:59:59.0000000Z",
    "instanceId":"/subscriptions/{subscriptionid}/resourceGroups/{resourcegroup}/providers/Microsoft.Cdn/profiles/{profile}",
    "instanceName":"{id}",
    "instanceLocation":"SouthCentralUS",
    "meterId":"6b88ada0-cbc0-4874-be0e-23004f8b4de7",
    "usageQuantity":0.002065,
    "pretaxCost":0,
    "currency":"USD",
    "additionalProperties": {
      "Provider": "1",
      "ConsumptionBeginTime": "2018-05-01T19:00:00",
      "ConsumptionEndTime": "2018-05-01T20:00:00"
    }
  }

こちらもご覧ください

言語固有の SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください。

Azure Consumption Python SDK

Azure Consumption CLI

Azure Consumption NodeJS SDK

Azure Consumption Ruby SDK