Reservations Summaries - List By Reservation Order And Reservation

參考

服務:: Consumption

API 版本:: 2024-08-01

列出每日或每月穀物的保留摘要。注意：ARM 的承載大小限制為 12MB，因此當回應大小超過 ARM 限制時，目前呼叫端會收到 400。在這種情況下，API 呼叫應該使用較小的日期範圍進行。

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&api-version=2024-08-01

含選擇性參數:

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&$filter={$filter}&api-version=2024-08-01

URI 參數

名稱	位於	必要	類型	Description
reservationId	path	True	string	保留的標識碼
reservationOrderId	path	True	string	保留的訂單標識碼
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前的版本是 2023-03-01。
grain	query	True	datagrain	可以是每日或每月
$filter	query		string	僅適用於每日穀物。開始日期和結束日期的屬性/UsageDate。篩選支援 'le' 和 'ge'

回應

名稱	類型	Description
200 OK	ReservationSummariesListResult	還行。要求已成功。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ReservationSummariesDailyWithReservationId

ReservationSummariesMonthlyWithReservationId

ReservationSummariesDailyWithReservationId

範例要求

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=daily&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20&api-version=2024-08-01

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_D8s_v3",
        "kind": "Reservation",
        "reservedHours": 0,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "totalReservedQuantity": 155,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithReservationId

範例要求

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&api-version=2024-08-01

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_D8s_v3",
        "kind": "Reservation",
        "reservedHours": 0,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "totalReservedQuantity": 155,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      }
    }
  ]
}

定義

名稱	Description
datagrain	可以是每日或每月
ErrorDetails	錯誤的詳細數據。
ErrorResponse	錯誤回應表示服務無法處理傳入要求。錯誤訊息中會提供原因。某些錯誤回應： 429 TooManyRequests - 要求已節流。等候「x-ms-ratelimit-microsoft.consumption-retry-after」標頭中指定的時間後重試。 503 ServiceUnavailable - 服務暫時無法使用。等候「Retry-After」標頭中指定的時間後重試。 504 閘道逾時 - 處理要求時服務逾時。儘可能減少要求中的日期範圍。
ReservationSummariesListResult	列出保留摘要的結果。
ReservationSummary	保留摘要資源。

datagrain

列舉型別

可以是每日或每月

值	Description
daily	每日數據粒紋
monthly	每月數據粒度

ErrorDetails

Object

錯誤的詳細數據。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息，指出作業失敗的原因。

ErrorResponse

Object

錯誤回應表示服務無法處理傳入要求。錯誤訊息中會提供原因。

某些錯誤回應：

429 TooManyRequests - 要求已節流。等候「x-ms-ratelimit-microsoft.consumption-retry-after」標頭中指定的時間後重試。
503 ServiceUnavailable - 服務暫時無法使用。等候「Retry-After」標頭中指定的時間後重試。
504 閘道逾時 - 處理要求時服務逾時。儘可能減少要求中的日期範圍。

名稱	類型	Description
error	ErrorDetails	錯誤的詳細數據。

ReservationSummariesListResult

Object

列出保留摘要的結果。

名稱	類型	Description
nextLink	string	結果下一頁的連結（url）。
value	ReservationSummary[]	保留摘要的清單。

ReservationSummary

Object

保留摘要資源。

名稱	類型	Description
etag	string	資源的 etag。
id	string	事件的完整ARM標識碼。
name	string	可唯一識別事件的標識碼。
properties.avgUtilizationPercentage	number (decimal)	這是整個時間範圍的平均使用率。（日或月視穀物而定）
properties.kind	string	保留種類。
properties.maxUtilizationPercentage	number (decimal)	這是使用量時間（日或月）中的每小時使用率上限。例如，如果使用量記錄對應至 2017/12/10，而 4 和 5 小時的使用量為 100%，則此欄位會傳回當天的 100%。
properties.minUtilizationPercentage	number (decimal)	這是使用時間（日或月）中的每小時使用率下限。例如，如果使用量記錄對應至 2017/12/10，而 4 和 5 小時的使用量則為 10%，則此欄位會傳回 10% 當天
properties.purchasedQuantity	number (decimal)	這是 reservationId 的購買數量。
properties.remainingQuantity	number (decimal)	這是 reservationId 的剩餘數量。
properties.reservationId	string	保留標識碼是保留訂單內保留的標識碼。每個保留都是套用權益範圍的群組，也會指定可套用保留權益的實例數目。
properties.reservationOrderId	string	保留訂單標識碼是保留購買的標識碼。每個保留訂單標識碼都代表單一購買交易。保留訂單包含保留。保留順序會指定保留的 VM 大小和區域。
properties.reservedHours	number (decimal)	這是保留的總時數。例如，如果 1 個實例的保留是在下午 1 點進行，則這一天會是 11 小時，而從後續幾天起 24 小時
properties.skuName	string	這是 ARM Sku 名稱。它可用來與 serviceType 字段聯結，以在使用量記錄中的其他資訊中。
properties.totalReservedQuantity	number (decimal)	這是保留給 reservationId 的實例總數。
properties.usageDate	string (date-time)	對應至使用率記錄的數據。如果數據的粒紋是每月，則會是當月的第一天。
properties.usedHours	number (decimal)	保留使用的時數總計
properties.usedQuantity	number (decimal)	這是 reservationId 所使用的數量。
properties.utilizedPercentage	number (decimal)	這是保留標識碼的使用量百分比。
tags	object	資源標籤。
type	string	資源類型。

共用方式為

Reservations Summaries - List By Reservation Order And Reservation

URI 參數

回應

安全性

azure_auth

範圍

範例

ReservationSummariesDailyWithReservationId

範例要求

範例回覆

ReservationSummariesMonthlyWithReservationId

範例要求

範例回覆

定義

datagrain

ErrorDetails

ErrorResponse

ReservationSummariesListResult

ReservationSummary

其他資源