查看和检索使用情况数据

已完成

“提供者”一词适用于服务管理员和任何委派的提供者。 Azure Stack Hub 运营商和委托提供商可以使用提供商使用情况应用程序编程接口 (API) 查看其直接租户的使用情况。 例如,如下图所示,P0 可以调用提供者 API,以获取 P1 和 P2 的直接使用情况信息;而 P1 可以通过调用来获取 P3 和 P4 的使用情况信息。

Diagram showing normalized relational tables.

应用程序编程接口 (API) 调用引用

请求

请求会获取所请求的订阅在请求的时间范围内的消耗量详细信息。 没有请求正文。

此使用情况应用程序编程接口是一种提供商应用程序编程接口,因此必须在提供商的订阅中为调用方分配所有者、参与者或读取者角色。

方法:GET

https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&subscriberId={sub1.1}&api-version=2015-06-01-preview&continuationToken={token-value}

参数

Argument 说明
armendpoint Azure Stack Hub 环境的 Azure 资源管理器终结点。 按 Azure Stack Hub 约定,Azure 资源管理器终结点名称的格式为 https://adminmanagement.{domain-name}
subId 进行调用的用户的订阅 ID。
reportedStartTime 查询的开始时间。 DateTime 的值应为以协调世界时 (UTC) 和小时开始时的时间呈现,例如 13:00。 对于每日聚合,请将此值设置为 UTC 午夜。
reportedEndTime 查询的结束时间。 适用于 reportedStartTime 的约束也适用于此参数。 reportedEndTime 的值不得为未来或当前的日期。 如果是,结果会设为“处理未完成”。
aggregationGranularity 具有两个离散可能值的可选参数:dailyhourly。 如同以上两个值所暗示,一个会每日返回数据,另一个则会每小时返回数据。
subscriberId 订阅 ID。 若要获取筛选的数据,需要提供者直接租户的订阅 ID。 如果未指定订阅 ID 参数,调用会返回所有提供者直接租户的使用情况数据。
api-version 用于发出此请求的协议版本。 此值设置为 2015-06-01-preview
continuationToken 从上次调用使用情况 API 提供者取回的标记。 响应大于 1,000 行时,需要此标记, 可作为进度的书签。 如果此标记不存在,则根据传入的粒度从一天或一小时的开始检索数据。

响应

GET
/subscriptions/sub1/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&subscriberId=sub1.1&api-version=1.0
Argument 说明
id 使用情况聚合的唯一 ID。
name 使用情况聚合的名称。
type 资源定义。
subscriptionId Azure Stack Hub 用户的订阅标识符。
usageStartTime 此使用情况聚合所属的使用情况存储桶 UTC 开始时间。
usageEndTime 此使用情况聚合所属的使用情况存储桶 UTC 结束时间。
instanceData 实例详细信息的键值对(采用新格式):resourceUri:完全限定的资源 ID,其中包括资源组和实例名称。 location:运行此服务的区域。 tags:用户指定的资源标记。 additionalInfo:关于所消耗资源的详细信息(例如 OS 版本或映像类型)。
quantity 此时间范围内发生的资源消耗数量。
meterId 所消耗资源的唯一 ID(也称 ResourceID)。

检索使用情况信息

PowerShell

若要生成使用情况数据,应具有正在运行且正在使用系统的资源。 例如,活动虚拟机或包含数据的存储帐户。

使用以下 PowerShell cmdlet 来查看使用情况数据:

  1. 安装适用于 Azure Stack Hub 的 PowerShell
  2. 配置 Azure Stack Hub 用户或 Azure Stack Hub 操作员 PowerShell 环境。
  3. 若要检索使用情况数据,请调用 Get-AzsSubscriberUsage PowerShell cmdlet:
Get-AzsSubscriberUsage -ReportedStartTime