你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
可以通过 Azure 使用情况 API 以编程方式访问 Azure 资源的成本和使用情况数据。 API 目前仅支持企业注册、Web Direct 订阅(少数例外)和 CSP Azure 计划订阅。 这些 API 会持续进行更新,以便为其他类型的 Azure 订阅提供支持。
Azure 使用情况 API 允许访问以下内容:
- 仅限企业客户
- 价目表
- 预算
- 预测
- Balances
- 标记
- 成本标签
- 企业和 Web Direct 客户
- 预留详细信息
- 预留摘要
- 市场费用
- 使用详情
- 预订建议
不受支持的订阅类型的列表
- 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 的更多信息,请访问以下内容