Azure Enterprise Reporting API の概要

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

Note

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

Azure Enterprise Reporting API を使用すると、Enterprise Azure の顧客はプログラムで消費量および請求先データを希望のデータ解析ツールに取り出すことができます。エンタープライズのお客様は、Azure とマイクロソフトエンタープライズ契約 (EA) に署名し、交渉済みの Azure 前払い (以前は年額コミットメントと呼ばれます) を行い、Azure リソースのカスタム価格にアクセスできます。

API に必要なすべての日付と時刻のパラメーターは、結合された協定世界時 (UTC) の値で表す必要があります。 API によって返される値は UTC 形式で表示されます。

API へのデータアクセス

API キーの生成または取得 - 詳細については、「API キーの生成」を参照してください。
API でのキーのパス-呼び出しごとに API キーを渡して認証と承認を受ける必要があります。次のプロパティは HTTP ヘッダーに対するプロパティである必要があります。

Request Header Key	Value
承認	次の形式で値を指定します:bearer {API_KEY} 例: bearer eyr....09

使用量ベースの API

Swagger エンドポイントは、次の API で使用できます。 API の簡単なイントロスペクションと、AutoRest または Swagger CodeGen を使用してクライアントソフトウェア開発キット (SDK) を生成する機能を有効にする必要があります。 2014 年 5 月 1 日以降のデータは、この API で使用できます。

残高と概要 - 残高と概要 API では、残高、新規購入、Azure Marketplace サービス料金、調整、超過料金に関する情報の月次概要が提供されます。
Usage Details - Usage Detail API を使用すると、毎日の消費量の内訳と加入契約別の推定料金が提示されます。この結果には、インスタンス、測定、および部署に関する情報も含まれています。請求期間、または指定した開始日と終了日で API にクエリを実行します。
Marketplace Store の料金 - Marketplace ストアの料金 API は、指定された請求期間または開始日と終了日 (1 回限りの料金は含まれません) について、使用量ベースの Marketplace 料金の内訳を日別に返します。
Price Sheet - Price Sheet API を使用すると、指定された加入契約と請求期間に対する各測定に適用可能な課金率が提供されます。
Reserved Instance Details - Reserved Instance 使用量 API を使用すると、予約インスタンス購入の使用状況が返されます。 Reserved Instance 料金 API を使用すると、行われた課金トランザクションが表示されます。

データの鮮度

Etag は、上記のすべての API の応答で返されます。 Etag の変更は、データが更新されたことを示します。同じパラメーターを使用した同じ API の後続の呼び出しでは、キャプチャされた Etag と、http 要求のヘッダー内のキー "If-None-Match" を渡します。応答状態コードは、 NotModified データがそれ以上更新されず、データが返されない場合です。 API は、etag の変更が発生するたびに、必要な期間の完全なデータセットを返します。

Helper API

請求期間の一覧表示 - Billing Periods API を使用すると、指定された加入契約の消費量データが含まれる請求期間の一覧が逆時系列順に返されます。各期間には、BalanceSummary、UsageDetails、Marketplace Charges および Price Sheet の 4 セットのデータの API ルートを示すプロパティが含まれています。

API 応答コード

応答の状態コード	Message	説明
200	[OK]	エラーなし
400	正しくない要求	無効なパラメーター – 日付範囲、EA 番号など
401	権限がありません	API キーが検出されない、正しくない、有効期限が切れている、など
404	使用不可	レポートのエンドポイントが見つからない
429	TooManyRequests	要求が調整されました。 `x-ms-ratelimit-microsoft.consumption-retry-after` ヘッダーで指定された時刻まで待ってから、再試行してください。
500	サーバーエラー	要求の処理中に予期しないエラーが発生した
503	ServiceUnavailable	サービスは、一時的に利用できません。 `Retry-After` ヘッダーで指定された時刻まで待ってから、再試行してください。