Benefit Recommendations - List

Service:

Cost Management

API Version:

2023-11-01

購買節省方案的建議清單。

GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2023-11-01

With optional parameters:

GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?$filter={$filter}&$orderby={$orderby}&$expand={$expand}&api-version=2023-11-01

URI 參數

名稱	位於	必要	類型	Description
billingScope	path	True	string	與權益建議作業相關聯的範圍。 這包括訂用帳戶範圍的 '/subscriptions/{subscriptionId}/' 、資源群組範圍的 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'、/providers/Microsoft.Billing/billingAccounts/{billingAccountId}'，以及 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' 用於計費配置文件範圍
api-version	query	True	string	用於此作業的 API 版本。
$expand	query		string	可用來展開屬性，方法是：properties/usage、properties/allRecommendationDetails
$filter	query		string	可用來篩選 benefitRecommendations，方法是：具有允許值 ['Single'、 'Shared'] 和預設值 'Shared' 的屬性/範圍;和 properties/lookBackPeriod 具有允許的值 ['Last7Days'、'Last30Days'、'Last60Days'] 和預設值 'Last60Days';屬性/字詞，其允許值 ['P1Y'、'P3Y'] 和預設值 'P3Y';properties/subscriptionId;properties/resourceGroup
$orderby	query		string	可用來依下列方式排序建議：properties/armSkuName。 針對節省方案，結果預設會依序排列。 不需要使用此子句。

回應

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

範例

BenefitRecommendationsBillingAccountList

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations?$filter=properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'&$expand=properties/usage,properties/allRecommendationDetails&api-version=2023-11-01

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.CostManagement/benefitRecommendations",
      "kind": "SavingsPlan",
      "properties": {
        "firstConsumptionDate": "2022-10-18T00:00:00Z",
        "lastConsumptionDate": "2022-10-25T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "totalHours": 168,
        "usage": {
          "usageGrain": "Hourly",
          "charges": [
            1,
            1,
            0,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            2,
            2,
            2,
            2
          ]
        },
        "armSkuName": "Compute_Savings_Plan",
        "term": "P1Y",
        "commitmentGranularity": "Hourly",
        "currencyCode": "USD",
        "costWithoutBenefit": 218.267,
        "scope": "Shared",
        "recommendationDetails": {
          "averageUtilizationPercentage": 99.33,
          "coveragePercentage": 54.609,
          "commitmentAmount": 0.164,
          "overageCost": 144.841,
          "benefitCost": 52.002,
          "savingsAmount": 21.424,
          "savingsPercentage": 9.815,
          "totalCost": 196.843,
          "wastageCost": 0.035
        },
        "allRecommendationDetails": {
          "value": [
            {
              "averageUtilizationPercentage": 99.33,
              "coveragePercentage": 54.609,
              "commitmentAmount": 0.164,
              "overageCost": 144.841,
              "benefitCost": 52.002,
              "savingsAmount": 21.424,
              "savingsPercentage": 9.815,
              "totalCost": 196.843,
              "wastageCost": 0.035
            },
            {
              "averageUtilizationPercentage": 81.474,
              "coveragePercentage": 56.748,
              "commitmentAmount": 0.161,
              "overageCost": 120.389,
              "benefitCost": 83.754,
              "savingsAmount": 14.124,
              "savingsPercentage": 6.47,
              "totalCost": 204.143,
              "wastageCost": 0.1
            }
          ]
        }
      }
    }
  ]
}

定義

名稱	Description
allSavingsBenefitDetails	權益建議詳細數據。
allSavingsList	具有建議詳細數據的所有權益建議清單。
benefitKind	Reservation 或 SavingsPlan。
benefitRecommendationModel	權益方案建議詳細數據。
benefitRecommendationsListResult	列出權益建議的結果。
ErrorDetails	錯誤的詳細數據。
ErrorResponse	錯誤回應表示服務無法處理傳入要求。 錯誤訊息中提供了原因。 某些錯誤回應： 429 TooManyRequests - 要求已節流。 等候 「x-ms-ratelimit-microsoft.consumption-retry-after」 標頭中指定的時間後重試。 503 ServiceUnavailable - 服務暫時無法使用。 請在等候「Retry-After」標頭中指定的時間之後重試。
grain	使用量的粒度。 支援的值：'Hourly'
lookBackPeriod	評估用於計算建議的使用量天數。
recommendationUsageDetails	firstConsumptionDate 與 lastConsumptionDate 之間的隨選費用，用於計算權益建議。
sharedScopeBenefitRecommendationProperties	當範圍為 『Shared』 時，權益建議的屬性。
singleScopeBenefitRecommendationProperties	當範圍為 『Single』 時，權益建議的屬性。
term	權益的期限。 例如，P1Y 或 P3Y。

allSavingsBenefitDetails

權益建議詳細數據。

名稱	類型	Description
averageUtilizationPercentage	number	回溯期間 『totalHours』 的預估平均使用率百分比，並具有此承諾。
benefitCost	number	在回溯期間內，具有 'totalHours' 權益的估計成本。 等於 (承諾用量 * totalHours)
commitmentAmount	number	承諾用量金額。
coveragePercentage	number	回溯期間 『totalHours』 的預估權益涵蓋範圍百分比，並具有此承諾。
overageCost	number	回溯期間 'totalHours' 的總成本和權益成本之間的差異。
savingsAmount	number	藉由購買建議的權益數量，在回溯期間為 『totalHours』 儲存的金額。
savingsPercentage	number	藉由購買建議的權益數量，以回溯期間'totalHours' 的百分比節省。
totalCost	number	總成本，這是權益成本和超額成本的總和。
wastageCost	number	'benefitCost' 的估計未使用部分。

allSavingsList

具有建議詳細數據的所有權益建議清單。

名稱	類型	Description
nextLink	string	連結 (URL) 至下一頁的結果。
value	allSavingsBenefitDetails[]	具有建議詳細數據的權益建議清單。

benefitKind

Reservation 或 SavingsPlan。

名稱	類型	Description
IncludedQuantity	string	權益為 IncludedQuantity。
Reservation	string	權益為保留。
SavingsPlan	string	權益為 SavingsPlan。

benefitRecommendationModel

權益方案建議詳細數據。

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Reservation 或 SavingsPlan。
name	string	資源的名稱
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	權益建議的屬性。
type	string	資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

benefitRecommendationsListResult

列出權益建議的結果。

名稱	類型	Description
nextLink	string	連結 (URL) 至下一頁的結果。
value	benefitRecommendationModel[]	權益建議的清單。

ErrorDetails

錯誤的詳細數據。

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

ErrorResponse

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

某些錯誤回應：

• 429 TooManyRequests - 要求已節流。 等候 「x-ms-ratelimit-microsoft.consumption-retry-after」 標頭中指定的時間後重試。

• 503 ServiceUnavailable - 服務暫時無法使用。 請在等候「Retry-After」標頭中指定的時間之後重試。

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

grain

使用量的粒度。 支援的值：'Hourly'

名稱	類型	Description
Daily	string	每小時粒紋對應至每天的值。
Hourly	string	每小時粒紋對應至每小時的值。
Monthly	string	每小時粒紋對應至每個月的值。

lookBackPeriod

評估用於計算建議的使用量天數。

名稱	類型	Description
Last30Days	string	30 天用來回頭查看。
Last60Days	string	60 天用來回頭查看。
Last7Days	string	用來回溯的 7 天。

recommendationUsageDetails

firstConsumptionDate 與 lastConsumptionDate 之間的隨選費用，用於計算權益建議。

名稱	類型	Description
charges	number[]	用於計算權益建議的 firstConsumptionDate 與 lastConsumptionDate 之間的每小時隨選費用。
usageGrain	grain	使用量的粒度。 支援的值：'Hourly'

sharedScopeBenefitRecommendationProperties

當範圍為 『Shared』 時，權益建議的屬性。

名稱	類型	Description
allRecommendationDetails	allSavingsList	具有建議詳細數據的所有權益建議清單。
armSkuName	string	ARM SKU 名稱。 SavingsPlan 的 'Compute_Savings_Plan'。
commitmentGranularity	grain	建議承諾用量的粒度。 支援的值：'Hourly'
costWithoutBenefit	number	目前沒有權益的成本，對應於回溯期間內的 『totalHours』。
currencyCode	string	成本的 ISO 4217 貨幣代碼標識碼，並節省金額。
firstConsumptionDate	string	用來回溯計算建議的第一個使用日期。
lastConsumptionDate	string	上次用於查看計算建議的使用日期。
lookBackPeriod	lookBackPeriod	評估用於計算建議的使用量天數。
recommendationDetails	allSavingsBenefitDetails	建議建議的詳細數據。
scope	string: Shared	權益範圍。 例如，單一或共用。
term	term	權益的期限。 例如，P1Y 或 P3Y。
totalHours	integer	涵蓋成本的總時數。 其等於屬性 『properties/usage/charges』 中的記錄數目。
usage	recommendationUsageDetails	firstConsumptionDate 與 lastConsumptionDate 之間的隨選費用，用於計算權益建議。

singleScopeBenefitRecommendationProperties

當範圍為 『Single』 時，權益建議的屬性。

名稱	類型	Description
allRecommendationDetails	allSavingsList	具有建議詳細數據的所有權益建議清單。
armSkuName	string	ARM SKU 名稱。 SavingsPlan 的 'Compute_Savings_Plan'。
commitmentGranularity	grain	建議承諾用量的粒度。 支援的值：'Hourly'
costWithoutBenefit	number	目前沒有權益的成本，對應於回溯期間內的 『totalHours』。
currencyCode	string	成本的 ISO 4217 貨幣代碼標識碼，並節省金額。
firstConsumptionDate	string	用來回溯計算建議的第一個使用日期。
lastConsumptionDate	string	上次用於查看計算建議的使用日期。
lookBackPeriod	lookBackPeriod	評估用於計算建議的使用量天數。
recommendationDetails	allSavingsBenefitDetails	建議建議的詳細數據。
resourceGroup	string	此單一範圍建議的資源群組。 只有在建議適用於 『Single』 範圍和 『ResourceGroup』 要求範圍時，才適用。
scope	string: Single	權益範圍。 例如，單一或共用。
subscriptionId	string	此單一範圍建議的訂用帳戶標識碼。 只有在建議適用於 「單一」範圍時，才適用。
term	term	權益的期限。 例如，P1Y 或 P3Y。
totalHours	integer	涵蓋成本的總時數。 其等於屬性 『properties/usage/charges』 中的記錄數目。
usage	recommendationUsageDetails	firstConsumptionDate 與 lastConsumptionDate 之間的隨選費用，用於計算權益建議。

term

權益的期限。 例如，P1Y 或 P3Y。

名稱	類型	Description
P1Y	string	權益期限為 1 年。
P3Y	string	權益期限為 3 年。