Azure 使用量 API 可讓您以程式設計方式存取 Azure 資源的成本和使用量資料。 API 目前僅支持企業註冊、Web Direct 訂閱(少數例外)和 CSP Azure 計劃訂閱。 API 會持續更新,以支援其他 Azure 訂用帳戶類型。
Azure 使用量 API 可存取:
- 僅限企業客戶
- 價位表
- 預算
- 預測
- Balances
- Tags
- 成本標籤
- 企業和 Web Direct 客戶
- 保留詳細資料
- 保留摘要
- Marketplace 費用
- 使用詳情
- 預訂建議
不支援的訂用帳戶類型清單
- MS-AZR-0145P (光熱)
- MS-AZR-0146P (光熱)
- MS-AZR-159P (光熱)
- MS-AZR-0036P (贊助)
- MS-AZR-0143P (贊助)
- MS-AZR-0015P (內部)
- MS-AZR-0144P (夢幻火花)
使用計費週期和日期範圍
使用方式詳細資訊 和 市場費用 接受計費週期或日期範圍,用於定義使用方式數據的開始日期和結束日期。
下面是基於請求中的計費週期和日期範圍的 API 行為。
| 請求中的計費週期 | 請求中的開始日期 | 請求中的結束日期 | API 行為 |
|---|---|---|---|
| 否 | 否 | 否 | 回應中返回當前計費周期的數據 |
| 否 | 是的 | 否 | 回應中返回當前計費周期的數據 |
| 否 | 否 | 是的 | 回應中返回當前計費周期的數據 |
| 否 | 是的 | 是的 | 回應中返回指定開始日期和結束日期的數據 |
| 是的 | 否 | 否 | 回應中返回指定計費周期的數據 |
| 是的 | 是的 | 否 | 回應中返回指定計費周期的數據 |
| 是的 | 否 | 是的 | 回應中返回指定計費周期的數據 |
| 是的 | 是的 | 是的 | 回應中返回指定開始日期和結束日期的數據,忽略提供的計費週期 |
一個請求允許的最大日期範圍為 12 個月,數據從 2014 年 5 月 1 日或更晚開始提供。
獲取計費週期清單
為了在請求中提供有效的計費週期,用戶端應首先使用以下 API 按訂閱獲取可用計費週期清單
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods?api-version=2017-04-24-preview
使用此清單,用戶端可以選擇特定的計費週期來獲取消耗數據。
延遲到達的數據
為了適應在報告使用方式時有延遲的第三方服務,報告的使用日期設置為發送使用方式數據的時間,而不是實際使用方式發生的時間,即消耗時間。
因此,將對使用方式進行評級並應用於報告的時間。 為了表示實際消耗時間, 屬性。AdditionalProperties 字段現在將包含兩個附加屬性。 ConsumptionBeginTime 和 ConsumptionEndTime 是與實際消耗時間窗口相對應的新字段。
這些更改將導致在調用使用方式詳細資訊 API 時需要解決的一些方案:
月末報告:對於一個月內發生但在下個月報告的使用方式,客戶需要查看 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 中使用此 API 的更多資訊,請存取以下內容