Azure Consumption API シリーズを使用すると、Azure リソースのコストおよび使用状況データにプログラムでアクセスできます。 現在、API は、エンタープライズ登録、Web Direct サブスクリプション (いくつかの例外を除く)、および CSP Azure プラン サブスクリプションのみをサポートしています。 API は、他の種類の Azure サブスクリプションをサポートするために継続的に更新されます。
Azure Consumption API シリーズでは、以下にアクセスできます。
- エンタープライズのお客様のみ
- 価格表
- 予算
- 予測
- Balances
- タグ
- コストタグ
- エンタープライズおよびWebダイレクトのお客様
- 予約の詳細
- 予約の概要
- Marketplace の料金
- 使用詳細
- 予約の推奨事項
サポートされていないサブスクリプションの種類の一覧
- MS-AZR-0145P(CSP)です。
- MS-AZR-0146P(CSP)
- MS-AZR-159P(CSP)です。
- MS-AZR-0036P (スポンサー付き)
- MS-AZR-0143P (スポンサー付き)
- MS-AZR-0015P (内部)
- MS-AZR-0144P (ドリームスパーク)
請求期間と日付範囲の操作
使用状況の詳細 と Marketplace 料金 では、使用状況データの開始日と終了日を定義するための請求期間または日付範囲が受け入れられます。
リクエストの請求期間と日付範囲に基づくAPIの挙動は以下の通りです:
| 請求期間 | 開始日は要請中 | 要請中の終了日 | API の動作 |
|---|---|---|---|
| いいえ | いいえ | いいえ | 現在の請求期間のデータが応答として返されます |
| いいえ | はい | いいえ | 現在の請求期間のデータが応答として返されます |
| いいえ | いいえ | はい | 現在の請求期間のデータが応答として返されます |
| いいえ | はい | はい | 指定した開始日と終了日のデータが応答で返されます |
| はい | いいえ | いいえ | 指定した請求期間のデータが応答として返されます |
| はい | はい | いいえ | 指定した請求期間のデータが応答として返されます |
| はい | いいえ | はい | 指定した請求期間のデータが応答として返されます |
| はい | はい | はい | 指定された開始日と終了日のデータは応答で返され、指定された請求期間は無視されます |
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か月間に発生した使用量が翌月に報告された場合、顧客は additionalProperties フィールドで使用量を適切な月に割り当てる必要があります。
使用情報のクエリ:使用情報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 の 1 つでこの API を使用する方法の詳細については、以下を参照してください