Azure 使用量

Azure 使用量 API 可讓您以程式設計方式存取 Azure 資源的成本和使用量資料。 API 目前僅支持企業註冊、Web Direct 訂用帳戶 (,但) 和 CSP Azure 方案訂用帳戶除外。 API 會持續更新,以支援其他 Azure 訂用帳戶類型。

Azure 使用量 API 可存取:

  • 僅限企業客戶
    • 價位表
    • 預算
    • 預測
    • 餘額
    • 標籤
    • 成本標籤
  • 企業和 Web Direct 客戶
    • 保留詳細資料
    • 保留摘要
    • 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 (DreamSpark)

使用計費週期和日期範圍

使用量詳細數據和Marketplace 費用 接受計費期間或日期範圍,以定義使用量數據的開始和結束日期。

以下是以要求中的計費週期和日期範圍為基礎的 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 字段現在會包含兩個額外的屬性。 ConsumptionBeginTimeConsumptionEndTime 是對應至實際耗用時間範圍的新字段。

這些變更會導致呼叫使用量詳細數據 API 時需要解決的幾個案例:

  1. 月份結束報告:針對在一個月期間發生的使用量,但在下個月回報,客戶必須查看 additionalProperties 字段,才能將使用量指派給適當的月份。

  2. 查詢使用量詳細數據:依日期範圍查詢使用量詳細數據 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 使用量 Python SDK

Azure 使用量 CLI

Azure 使用量 NodeJS SDK

Azure 使用量 Ruby SDK