Compartilhar via

从消耗使用情况详细信息 API 迁移

本文介绍如何从消耗用量详细信息 API 迁移,我们已计划弃用该 API。 具体的弃用日期仍有待确定。 建议不要使用此 API 生成报告管道,而应该尽快迁移。

企业协议 (EA) 报告 API(使用 API 密钥进行身份验证并通过 consumption.azure.com URI 终结点访问)将停用。 使用这些 API 的 EA 客户应迁移到成本管理成本详细信息 API。 这些旧版 EA 报告 API 仅适用于签订了企业协议的客户。

如果你使用的是消耗用量详细信息 API,我们建议(但不要求)迁移到成本管理成本详细信息 API

消耗和成本管理 API 适用于 EA Microsoft 客户协议 (MCA) 客户。 对于仍然根据 EA 协议运行的 Azure 政府 客户,不会受到负面影响。

从 EA 迁移到 MCA 时,我们建议从 EA 用量详细信息报告 API 迁移到成本管理成本详细信息 API 并使用导出。

迁移目标

在选择适合你工作负载的解决方案之前,请阅读选择成本详细信息解决方案一文。 一般情况下,如果要持续引入数据或每月使用情况详细信息数据集较大,则建议使用导出。 有关详细信息,请参阅导入使用明细数据

如果用量详细信息数据集较小或场景不满足“导出”的条件,请考虑改用成本详细信息报告。 有关详细信息,请参阅按需获取小型成本数据集

注意

Cost Details 报表仅适用于具有企业协议或Microsoft 客户协议的客户。 如果您拥有 MSDN、按需付费或 Visual Studio 订阅,您可以迁移到导出功能,或继续使用使用情况详细信息 API。

迁移优点

与耗使用情况详细信息 API 相比,新解决方案提供了许多优势。 摘要如下:

  • 所有使用情况详细信息的单一数据集 - Azure 和 Azure 市场 使用情况详细信息合并到一个数据集中。 它减少了您为查看所有费用而需要调用的 API 计数。
  • 可扩展性 - Marketplaces API 已弃用,因为它支持的调用模式无法随着 Azure 使用量的增加而扩展。 随着将更多资源部署到云中,使用情况详细信息数据集可能会变得非常大。 市场 API 是一个分页同步 API,因此它没有经过优化,无法通过网络高效可靠地有效传输大量数据。 “导出”和成本详细信息 API 是异步的。 它们提供可通过网络直接下载的 CSV 文件。
  • API 改进 - 导出和成本详细信息 API 是 Azure 未来支持的解决方案。 所有新功能都将集成到这些解决方案中。
  • 架构一致性 - 成本详细信息报告和导出提供了具有匹配字段的文件,使得您可以根据您的需求将文件从一个解决方案迁移到另一个解决方案。
  • 成本分配集成 - 企业协议客户和 Microsoft 客户协议客户在使用导出或成本详细信息 API 时,可以查看根据其配置的成本分配规则生成的费用。 有关成本分配的详细信息,请参阅分配成本

字段差异

下表汇总了“消耗使用情况详细信息”API 和“导出”/“成本详细信息”API 之间的字段差异。 “导出”和“成本详细信息”API 提供 CSV 文件下载,而不是消费 API 提供的分页 JSON 响应。

企业协议字段映射

使用“消耗使用情况详细信息”API 的企业协议客户具有类型 legacy 的使用情况详细信息记录。 由于所有企业协议客户都会使用基础计费系统,因此他们都有此类型的记录。 下面是旧版用量详细信息记录示例:

{  

  "value": [  

      {  

          "id": "{id}", 

          "name": "{name}",  

          "type": "Microsoft.Consumption/usageDetails",  

          "kind": "legacy",  

          "tags": {  

               "env": "newcrp",  

               "dev": "tools"  

          },  

          "properties": {  

…... 

      } 

} 

Usage Details - List - REST API (Azure Consumption)中显示了完整的旧版使用详情记录。

下表提供了旧字段和新字段之间的映射。 “导出”和“成本详细信息”API 生成的 CSV 文件中提供了新属性。 若要了解有关字段的详细信息,请参阅了解使用情况详细信息字段

粗体属性名称保持不变。

旧属性 新属性
账户名称 账户名称
AccountOwnerId 账户所有者ID
附加信息 附加信息
AvailabilityZone 可用性区域
账单账户ID 计费账户ID
账单账户名称 账单账户名称
计费货币 账单货币代码
账单周期结束日期 账单周期结束日期
账单周期开始日期 账单周期开始日期
billingProfileId BillingProfileId
billingProfileName BillingProfileName
费用类型 计费类型
已使用服务 ConsumedService
成本 以计费货币计算的成本
成本中心 CostCenter
日期 日期
有效价格 EffectivePrice
频率 频率
发票部分 发票部分名称
InvoiceSectionId InvoiceSectionId
是否符合Azure信用条件 是否符合Azure信用额度资格
仪表类别 仪表类别
meterId 计量 ID
计量名称 计量器名称
MeterRegion MeterRegion
仪表子类别 MeterSubCategory
报价编号 优惠编号
部件编号 部件编号
PayGPrice PayGPrice
PlanName 计划名称
PricingModel 定价模型
产品 ProductName
ProductOrderId 产品订单ID
ProductOrderName 产品订单名称
PublisherName 出版社名称
PublisherType 发布者类型
数量 数量
ReservationId 预订ID
ReservationName 预订名称
resourceGroup ResourceGroup
资源 ID ResourceId
resourceLocation ResourceLocation
资源名称 资源名称
serviceFamily ServiceFamily
ServiceInfo1 ServiceInfo1
ServiceInfo2 ServiceInfo2
订阅编号 SubscriptionId(订阅ID)
订阅名称 订阅名称
标记 标记
条款 术语
计量单位 度量单位
单价 单价
CostAllocationRuleName 成本分配规则名称

Microsoft 客户协议字段映射

使用消耗用量详情 API 的 Microsoft 客户协议 客户具有类型modern的用量详情记录。 所有 Microsoft 客户协议 客户都有此类记录,这是由于为他们使用的基础计费系统。 这里是一个 MCA 用量详情记录示例:

{  

  "value": [  

      {  

          "id": "{id}", 

          "name": "{name}",  

          "type": "Microsoft.Consumption/usageDetails",  

          "kind": "modern",  

          "tags": {  

               "env": "newcrp",  

               "dev": "tools"  

          },  

          "properties": {  

…... 

      } 

} 

Usage Details - List - REST API (Azure Consumption)中显示了完整的旧版使用详情记录。

下表显示了旧字段和新字段之间的映射。 “导出”和“成本详细信息”API 生成的 CSV 文件中提供了新属性。 由于解决方案之间的差异而需要映射的字段以粗体文本显示。

有关详细信息,请参阅了解使用情况详细信息字段

旧属性 新属性
发票编号 (invoiceId) 发票编号 (invoiceId)
之前的发票ID 之前的发票ID
账单账户ID 账单账户ID
账单账户名称 账单账户名称
billingProfileId billingProfileId
billingProfileName billingProfileName
invoiceSectionId invoiceSectionId
发票部分名称 发票部分名称
partnerTenantId (合作伙伴租户ID) partnerTenantId (合作伙伴租户ID)
合作伙伴名称 合作伙伴名称
经销商名称 经销商名称
resellerMpnId resellerMpnId
客户租户ID 客户租户ID
客户名称 客户名称
成本中心 成本中心
账单周期结束日期 账单周期结束日期
账单周期开始日期 账单周期开始日期
服务期限结束日期 服务期限结束日期
服务期间开始日期 服务期间开始日期
日期 日期
serviceFamily serviceFamily
产品订单ID 产品订单ID
产品订单名称 产品订单名称
已使用服务 已使用服务
meterId meterId
计量名称 计量名称
仪表类别 仪表类别
仪表子类别 仪表子类别
meterRegion meterRegion
productIdentifier 产品 ID
产品 ProductName
subscriptionGuid SubscriptionId
订阅名称 订阅名称
发行商类型 发行商类型
publisherId publisherId
出版商名称 出版商名称
resourceGroup resourceGroupName
instanceName ResourceId
resourceLocationNormalized 位置
resourceLocation 位置
有效价格 有效价格
数量 数量
计量单位 计量单位
费用类型 费用类型
billingCurrencyCode 计费货币
价格货币代码 (pricingCurrencyCode) 定价货币
以计费货币计算的成本 以计费货币计算的成本
定价货币中的成本 定价货币中的成本
costInUsd costInUsd
按用量付费的计费货币金额 按用量付费的计费货币金额
paygCostInUSD paygCostInUsd
汇率从定价到计费 汇率从定价到计费
汇率日期 汇率日期
是否符合Azure信用条件 是否符合Azure信用条件
serviceInfo1 serviceInfo1
serviceInfo2 serviceInfo2
附加信息 附加信息
标记 标记
合作伙伴赚取的信用率 合作伙伴赚取的信用率
合作伙伴获得的信用已应用 合作伙伴获得的信用已应用
marketPrice PayGPrice
频率 频率
术语 术语
预订编号 预订编号
预订名称 预订名称
定价模型 定价模型
单价 单价
汇率从定价到计费 汇率从定价到计费