共用方式為


供應商資源使用 API

提供者 一詞適用於服務管理員和任何委派的提供者。 Azure Stack Hub 作業員和受委派的提供者可以使用提供者使用量 API 來檢視其直接租戶的使用量。 例如,如下圖所示,P0 可以呼叫提供者 API 以取得 P1 和 P2 的直接使用資訊,而 P1 可以呼叫 P3 和 P4 的使用資訊。

提供者階層的概念模型

API 呼叫參考

請求

要求會取得所要求訂閱和所要求時間範圍的取用詳細數據。 沒有請求主體。

此使用 API 是供應者 API,因此呼叫者必須在供應者的訂用帳戶中被指派 擁有者參與者讀者 角色。

方法 要求 URI
獲取 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 端點是 https://adminmanagement.local.azurestack.external
subId 撥打電話的使用者訂用帳戶標識碼。
reportedStartTime 查詢的開始時間。 DateTime 的值應為國際標準時間(UTC)且在小時開頭;例如,13:00。 針對每日匯總,請將此值設定為UTC午夜。 格式會逸出 ISO 8601;例如,2015-06-16T18%3a53%3a11%2b00%3a00Z,其中冒號會逸出至 %3a,而 加號則會逸出至 %2b,使其符合 URI。
reportedEndTime 查詢的結束時間。 套用至 reportedStartTime 的條件約束也適用於這個參數。 reportedEndTime 的值不能是未來或目前的日期。 如果是,結果會設定為「處理未完成」。
aggregationGranularity 具有兩個離散潛在值的選擇性參數:每日 和每小時 。 如值所建議,一個會以每日數據粒度傳回數據,另一個則是每小時的解析度。 每日 選項為預設值。
subscriberId 訂用帳戶標識碼。 若要取得篩選的數據,則需要提供者之直接租用戶的訂用帳戶標識碼。 如果未指定訂用帳戶標識碼參數,呼叫會傳回所有提供者直接租使用者的使用量數據。
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 來檢視使用量資料:

  1. 安裝 Azure Stack Hub 的 PowerShell

  2. 設定 Azure Stack Hub 使用者Azure Stack Hub 操作員 PowerShell 環境。

  3. 若要擷取使用量數據,請呼叫 Get-AzsSubscriberUsage PowerShell Cmdlet:

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

REST API

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

傳回所有活動用戶的已刪除租戶使用量

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

傳回已刪除或活躍租戶的使用情况

方法 要求 URI
獲取 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

後續步驟