從 EA 使用量詳細資料 API 移轉
先前在 consumption.azure.com 端點後方使用 Enterprise 報表 API 以取得使用量詳細資料和市集費用的 EA 客戶,需要移轉至新的改善解決方案。 指示如下所述,其中也附帶舊 API 與新解決方案之間的任何合約差異。
資料集稱為成本詳細資料,而不是使用量詳細資料。
注意
所有 Azure 企業版報告 API 都已淘汰。 您應該儘快移轉至 Microsoft 成本管理 API。
正式推出新解決方案
下表提供可用的移轉目的地摘要,以及選擇哪一個解決方案最適合時的考量項目摘要。
解決方法 | 描述 | 考量 | 上線資訊 |
---|---|---|---|
匯出 | 依排程將週期性資料傾印到儲存體 | - 適用於您工作負載的最可調整解決方案。 - 可以設定為針對較大的資料集使用檔案分割。 - 非常適合用來建立和擴增成本資料集,該資料集可與您自己的可查詢資料存放區整合。 - 需要存取可保存資料的儲存體帳戶。 |
- 在 Azure 入口網站中設定 使用 API 自動建立匯出 - 匯出 API 參考 |
成本詳細資料 API | 視需要下載 | - 適用於小型成本資料集。 - 適用於因為安全性或管理性考慮而無法匯出至 Azure 儲存體的情況。 |
- 視需要取得小型成本資料集 - 成本詳細資料 API |
一般而言,如果您有進行中的資料擷取需求和/或大型每月成本詳細資料資料集,建議您使用匯出。 如需詳細資訊,請參閱內嵌成本詳細資料。 如果需要其他資訊來協助您為工作負載做出決策,請參閱選擇成本詳細資料解決方案。
將權限指派給服務主體名稱以呼叫 API
如果您想要以程式設計方式呼叫匯出或成本詳細數據 API,您必須以正確的許可權設定服務主體。 如需詳細資訊,請參閱將權限指派給 ACM API。
避免 Microsoft 取用使用量詳細資料 API
取用使用量詳細資料 API 是目前支援 EA 客戶的另一個端點。 請勿移轉至此 API。 如本文件稍早所述,移轉至匯出或成本詳細資料 API。 取用使用量詳細數據 API 將會在未來淘汰,且位於下列端點後面。
GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/usageDetails?api-version=2021-10-01
此 API 是同步端點,無法隨著您的支出和月份成本資料集大小增加而調整。 如果您目前使用取用使用量詳細資料 API,建議您儘快將其移轉至匯出或成本詳細資料 API。 將在未來的日期發佈正式淘汰公告。 若要深入瞭解從使用量使用量詳細資料移轉,請參閱從耗用使用量詳細資料 API 移轉。
移轉優點
我們的新解決方案可透過 EA 報告使用量詳細資料 API 提供許多優點。 摘要如下:
- 安全性和穩定性 - 新解決方案需要服務主體和/或使用者權杖,才能存取資料。 這些解決方案比用來向 EA 報告 API 進行驗證的 API 金鑰更安全。 這些舊版 API 中的金鑰有效期為六個月,如果外泄,可能導致公開機密財務資料。 此外,如果在金鑰到期前未更新金鑰並整合到工作負載中,則會撤銷數據存取權。 這會中斷客戶工作負載。
- 延展性 - EA 報告 API 不是為了當您 Azure 使用量增加時調整規模而建置。 您將更多資源部署到雲端時,使用量詳細資料資料集可能會變得非常大。 新的解決方案為非同步,並具有其背後的廣泛基礎結構增強功能,以確保任何大小資料集的下載都能成功。
- 所有使用量詳細 數據的單一數據集 - Azure 和 Azure Marketplace 使用量詳細數據已合併到新解決方案中的一個數據集。 單一資料集可減少您查看所有費用時需要呼叫的 API 數目。
- 購買分攤 - 購買保留的客戶可以使用新解決方案查看其成本的分攤檢視。
- 架構一致性 - 每個可用解決方案都會提供符合欄位的檔案。 可讓您根據案例輕鬆地在解決方案之間移動。
- 成本配置整合 - Enterprise 合約 和 Microsoft 客戶合約 客戶可以使用新的解決方案來檢視與他們設定的成本配置規則相關的費用。 如需成本配置的詳細資訊,請參閱配置成本。
- 繼續改善 - 正在積極開發新的解決方案。 解決方案會在發行時接收所有新功能。
要移轉的企業使用量 API
下表摘要說明您可能目前使用的不同 API 來擷取成本詳細數據。 如果您使用下列其中一個 API,您必須移轉至先前所述的其中一個新解決方案。 所有 API 都位於端點後方 https://consumption.azure.com 。
端點 | API 註解 |
---|---|
/v3/enrollments/{enrollmentNumber}/usagedetails/download?billingPeriod={billingPeriod} |
- API 方法:GET - 同步 (非輪詢) - 資料格式:CSV |
/v3/enrollments/{enrollmentNumber}/usagedetails/download?startTime=2017-01-01&endTime=2017-01-10 |
- API 方法:GET - 同步 (非輪詢) - 資料格式:CSV |
/v3/enrollments/{enrollmentNumber}/usagedetails |
- API 方法:GET - 同步 (非輪詢) - 資料格式:JSON |
/v3/enrollments/{enrollmentNumber}/billingPeriods/{billingPeriod}/usagedetails |
- API 方法:GET - 同步 (非輪詢) - 資料格式:JSON |
/v3/enrollments/{enrollmentNumber}/usagedetailsbycustomdate?startTime=2017-01-01&endTime=2017-01-10 |
- API 方法:GET - 同步 (非輪詢) - 資料格式:JSON |
/v3/enrollments/{enrollmentNumber}/usagedetails/submit?billingPeriod={billingPeriod} |
- API 方法:POST - 非同步 (輪詢型) - 資料格式:CSV |
/v3/enrollments/{enrollmentNumber}/usagedetails/submit?startTime=2017-04-01&endTime=2017-04-10 |
- API 方法:POST - 非同步 (輪詢型) - 資料格式:CSV |
資料欄位對應
下表提供您目前使用之解決方案中可用的舊欄位摘要,以及要用於新解決方案的欄位。
舊欄位 | 新增欄位 | 註解 |
---|---|---|
accountId | ||
accountName | AccountName | |
accountOwnerEmail | AccountOwnerId | |
additionalInfo | AdditionalInfo | |
chargesBilledSeparately | isAzureCreditEligible | 屬性相反。 如果 isAzureCreditEnabled 為 true, ChargesBilledSeparately 則為 false。 |
consumedQuantity | 數量 | |
consumedService | ConsumedService | |
consumedServiceId | ConsumedService | consumedServiceId 只提供數字值。ConsumedService 提供服務的名稱。 |
成本 | CostInBillingCurrency | |
costCenter | CostCenter | |
date | Date | 舊欄位中的格式為 yyyy-mm-dd,而新欄位的格式為 mm/dd/yyyy。 |
departmentId | InvoiceSectionId | |
departmentName | InvoiceSectionName | |
extendedCost | CostInBillingCurrency | |
instanceId | ResourceId | |
isRecurringCharge | 適用時,請使用 Frequency 和 Term fields 前進。 |
|
location | ResourceLocationNormalized | |
meterCategory | 計量類別目錄 | |
meterId | MeterId | |
meterName | MeterName | |
meterRegion | MeterRegion | |
meterSubCategory | MeterSubCategory | |
offerId | OfferId | |
orderNumber | 無法使用。 | |
partNumber | PartNumber | |
planName | PlanName | |
product | ProductName | |
publisherName | PublisherName | |
resourceGroup | ResourceGroup | |
resourceGuid | MeterId | 值會有所不同。 resourceGuid 是 GUID 值。 meterId 是長數字。 |
resourceLocation | 資源位置 | |
resourceLocationId | 無法使用。 | |
resourceRate | EffectivePrice | |
serviceInfo1 | ServiceInfo1 | |
serviceInfo2 | ServiceInfo2 | |
serviceName | 計量類別目錄 | |
serviceTier | MeterSubCategory | |
storeServiceIdentifier | 無法使用。 | |
subscriptionGuid | SubscriptionId | |
subscriptionId | SubscriptionId | |
subscriptionName | SubscriptionName | |
tags | 標籤 | 新的欄位沒有 {} 括住索引鍵/值組。 |
unitOfMeasure | UnitOfMeasure |