提供者資源使用狀況 API

發行項
03/29/2024

「提供者」一詞適用於服務管理員和任何委派的提供者。 Azure Stack Hub 操作員和委派的提供者可使用提供者使用狀況 API，檢視其直接租用戶的使用狀況。例如，如下圖所示，P0 可以呼叫提供者 API，以在 P1 和 P2 上取得直接使用狀況資訊；而 P1 可呼叫以取得 P3 和 P4 的使用狀況資訊。

提供者階層的概念模型

API 呼叫參考

要求

要求會取得所要求的訂用帳戶在要求的時間範圍內的耗用量詳細資料。沒有要求主體。

此使用狀況 API 是提供者 API，因此必須將提供者訂用帳戶中的「擁有者」、「參與者」或「讀者」角色指派給呼叫者。

方法	要求 URI
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}`

引數

引數	描述
`armendpoint`	您 Azure Stack Hub 環境的 Azure Resource Manager 端點。依 Azure Stack Hub 慣例，Azure Resource Manager 端點名稱的格式是 `https://adminmanagement.{domain-name}`。例如，如果是 Azure Stack 開發套件 (ASDK)，則網域名稱會是 local.azurestack.external，而 Resource Manager 端點會是。
`subId`	進行呼叫之使用者的訂用帳戶識別碼。
`reportedStartTime`	查詢的開始時間。 `DateTime` 值應該以國際標準時間 (UTC) 格式及小時開始時的時間呈現，例如 13:00。對於每日彙總，請將這個值設定為 UTC 午夜。格式是逸出的 ISO 8601，例如 `2015-06-16T18%3a53%3a11%2b00%3a00Z`，其中冒號會逸出為 `%3a` 而加號會逸出為 `%2b`，使其符合 URI 規範。
`reportedEndTime`	查詢的結束時間。適用於 `reportedStartTime` 的限制也適用於此引數。 `reportedEndTime` 的值不得為未來或目前的日期。如果是，結果會設為「處理未完成。」
`aggregationGranularity`	這是選擇性引數，它可以有兩個截然不同的可能值 (每日及每小時)。如同以上兩個值所暗示，一個會每日傳回資料，另一個則會每小時傳回資料。預設值為 [每日] 選項。
`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

{
"value": [
{

"id":
"/subscriptions/sub1.1/providers/Microsoft.Commerce.Admin/UsageAggregate/sub1.1-

meterID1",
"name": "sub1.1-meterID1",
"type": "Microsoft.Commerce.Admin/UsageAggregate",

"properties": {
"subscriptionId":"sub1.1",
"usageStartTime": "2015-03-03T00:00:00+00:00",
"usageEndTime": "2015-03-04T00:00:00+00:00",
"instanceData":"{\"Microsoft.Resources\":{\"resourceUri\":\"resourceUri1\",\"location\":\"Alaska\",\"tags\":null,\"additionalInfo\":null}}",
"quantity":2.4000000000,
"meterId":"meterID1"

}
},

. . .

回應詳細資料

引數	描述
`id`	使用情況彙總的唯一識別碼。
`name`	使用情況彙總的名稱。
`type`	資源定義。
`subscriptionId`	Azure Stack Hub 使用者的訂用帳戶識別碼。
`usageStartTime`	此使用情況彙總所屬的使用情況貯體 UTC 開始時間。
`usageEndTime`	此使用情況彙總所屬的使用情況貯體 UTC 結束時間。
`instanceData`	執行個體詳細資料的機碼值組 (新格式)： `resourceUri`：完整資源識別碼，包含資源群組和執行個體名稱。 `location`：執行此服務的區域。 `tags`：使用者所指定的資源標記。 `additionalInfo`：更多關於所用資源的詳細資料 (例如 OS 版本或映像類型)。
`quantity`	此時間範圍內發生的資源取用數量。
`meterId`	所取用資源的唯一識別碼 (亦稱為 `ResourceID`)。

擷取使用量資訊

PowerShell

若要產生使用量資料，您應該要有正在執行且積極地使用系統的資源，例如作用中的虛擬機器 (VM) 或包含某些資料的儲存體帳戶。如果不確定是否有任何資源正在 Azure Stack Hub Marketplace 中執行，請部署 VM，並檢查 VM 監控刀鋒視窗以確定它正在執行。請使用下列 PowerShell Cmdlet 檢視使用量資料：

安裝適用於 Azure Stack Hub 的 PowerShell。
設定 Azure Stack Hub 使用者或 Azure Stack Hub 操作員的 PowerShell 環境。

若要擷取使用量資料，請呼叫 Get-AzsSubscriberUsage PowerShell Cmdlet：

Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"

REST API

您可呼叫 Microsoft.Commerce.Admin 服務，以收集已刪除訂用帳戶的使用量資訊。

傳回已刪除或作用中使用者的所有租用戶使用量

方法	要求 URI
GET	`https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview`

傳回已刪除或作用中使用者的使用量

方法	要求 URI
GET	`https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&subscriberId={subscriber-id}&api-version=2015-06-01-preview`