你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
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	可用于按以下方式筛选权益建议：具有允许值 ['Single'， 'Shared'] 和默认值“Shared”的属性/范围;和 properties/lookBackPeriod，具有允许的值 ['Last7Days'， 'Last30Days'， 'Last60Days'] 和默认值'Last60Days';具有允许值 ['P1Y'， 'P3Y'] 和默认值“P3Y”的 properties/term;properties/subscriptionId;properties/resourceGroup
$orderby	query		string	可用于按：properties/armSkuName 对建议进行排序。对于节省计划，结果默认按顺序排列。无需使用此子句。

响应

名称	类型	说明
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

名称	说明
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
            }
          ]
        }
      }
    }
  ]
}

定义

名称	说明
allSavingsBenefitDetails	权益建议详细信息。
allSavingsList	包含建议详细信息的所有权益建议的列表。
benefitKind	预留或 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	范围为“共享”时权益建议的属性。
singleScopeBenefitRecommendationProperties	范围为“Single”时，权益建议的属性。
term	权益的期限。例如，P1Y 或 P3Y。

allSavingsBenefitDetails

权益建议详细信息。

名称	类型	说明
averageUtilizationPercentage	number	回溯期间“totalHours”的估计平均利用率百分比，以及此承诺。
benefitCost	number	回溯期间“totalHours”的估计成本与权益。它等于 (commitmentAmount * totalHours)
commitmentAmount	number	承诺金额在 commitmentGranularity。
coveragePercentage	number	回溯期间“totalHours”的估计福利覆盖率百分比，以及此承诺。
overageCost	number	回溯期间“totalHours”的总成本和权益成本之间的差异。
savingsAmount	number	通过购买建议的权益数量，在回溯期间为“totalHours”节省的金额。
savingsPercentage	number	通过购买建议的福利数量，在回溯期间“totalHours”的节省百分比。
totalCost	number	总成本，即权益成本和超额成本的总和。
wastageCost	number	“benefitCost”的估计未使用部分。

allSavingsList

包含建议详细信息的所有权益建议的列表。

名称	类型	说明
nextLink	string	链接 (URL) 结果的下一页。
value	allSavingsBenefitDetails[]	包含建议详细信息的权益建议列表。

benefitKind

预留或 SavingsPlan。

名称	类型	说明
IncludedQuantity	string	权益为 IncludedQuantity。
Reservation	string	权益是预留。
SavingsPlan	string	好处是 SavingsPlan。

benefitRecommendationModel

权益计划建议详细信息。

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	预留或 SavingsPlan。
name	string	资源的名称
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	权益建议的属性。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

benefitRecommendationsListResult

列出权益建议的结果。

名称	类型	说明
nextLink	string	链接 (URL) 结果的下一页。
value	benefitRecommendationModel[]	权益建议列表。

ErrorDetails

错误的详细信息。

名称	类型	说明
code	string	错误代码。
message	string	指示操作失败原因的错误消息。

ErrorResponse

错误响应指示服务无法处理传入请求。错误消息中提供了原因。

某些错误响应：

429 TooManyRequests - 请求受到限制。等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。
503 ServiceUnavailable - 服务暂时不可用。等待“Retry-After”标头中指定的时间后重试。

名称	类型	说明
error	ErrorDetails	错误的详细信息。

grain

用法的粒度。支持的值：“Hourly”

名称	类型	说明
Daily	string	每小时粒度对应于每天的值。
Hourly	string	每小时粒度对应于每小时的值。
Monthly	string	每小时粒度对应于每月的值。

lookBackPeriod

为计算建议而评估的使用情况天数。

名称	类型	说明
Last30Days	string	30 天过去回顾。
Last60Days	string	60 天过去回顾。
Last7Days	string	7 天过去回顾。

recommendationUsageDetails

用于计算权益建议的 firstConsumptionDate 和 lastConsumptionDate 之间的按需费用。

名称	类型	说明
charges	number[]	用于计算权益建议的 firstConsumptionDate 和 lastConsumptionDate 之间的每小时按需收费。
usageGrain	grain	用法的粒度。支持的值：“Hourly”

sharedScopeBenefitRecommendationProperties

范围为“共享”时权益建议的属性。

名称	类型	说明
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”时，权益建议的属性。

名称	类型	说明
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	此单一范围建议所针对的资源组。仅当建议针对“单一”范围和“ResourceGroup”请求范围时适用。
scope	string: Single	权益范围。例如，“单一”或“共享”。
subscriptionId	string	此单一范围建议所针对的订阅 ID。仅当建议针对“单一”范围时适用。
term	term	权益的期限。例如，P1Y 或 P3Y。
totalHours	integer	涵盖成本的总小时数。它等于属性“properties/usage/charges”中的记录数。
usage	recommendationUsageDetails	用于计算权益建议的 firstConsumptionDate 和 lastConsumptionDate 之间的按需费用。

term

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

名称	类型	说明
P1Y	string	权益期限为 1 年。
P3Y	string	权益期限为 3 年。