Benefit Recommendations - List

Служба:
Cost Management
Версия API:
2026-06-01

Список рекомендаций по приобретению плана экономии.

GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2026-06-01
С использованием необязательных параметров: 
GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2026-06-01&$filter={$filter}&$orderby={$orderby}&$expand={$expand}

Параметры URI

Имя В Обязательно Тип Описание
billingScope
 path True

string

Область, связанная с операциями рекомендаций по преимуществам. Это включает в себя "/subscriptions/{subscriptionId}/" для области подписки, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для области группы ресурсов, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}" для области соглашения предприятия и "/поставщики/Microsoft.Billing/billingAccountS/{billingAccountId}/billingProfiles/{billingProfileId}" для области профиля выставления счетов
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.
$expand
 query

string

Можно использовать для расширения свойств по следующим свойствам: properties/usage, properties/allRecommendationDetails
$filter
 query

string

Можно использовать для фильтрации преимуществRecommendations по свойствам и области с допустимыми значениями ['Single', 'Shared'] и значением по умолчанию "Shared"; and properties/lookBackPeriod с допустимыми значениями ['Last7Days', Last30Days', Last60Days' и значением по умолчанию Last60Days; properties/term с допустимыми значениями ['P1Y', P3Y' и значением по умолчанию P3Y; properties/subscriptionId; properties/resourceGroup
$orderby
 query

string

Может использоваться для упорядочивания рекомендаций по свойствам/armSkuName. Для плана экономии результаты по умолчанию упорядочены. Нет необходимости использовать это предложение.

Ответы

Имя Тип Описание
200 OK

benefitRecommendationsListResult

Операция Azure успешно завершена.
Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation выдать себя за учетную запись пользователя

Примеры

BenefitRecommendationsBillingAccountList
BenefitRecommendationsManagementGroupList

BenefitRecommendationsBillingAccountList

Образец запроса

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

Пример ответа

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

BenefitRecommendationsManagementGroupList

Образец запроса

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations?api-version=2026-06-01&$filter=properties/scope eq 'ManagementGroup' AND properties/managementGroupId eq '/providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-000000000001' AND properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'&$expand=properties/usage,properties/allRecommendationDetails

Пример ответа

Код состояния:
200 
{
  "value": [
    {
      "name": "00000000-0000-0000-0000-000000000000",
      "type": "Microsoft.CostManagement/benefitRecommendations",
      "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000",
      "kind": "SavingsPlan",
      "properties": {
        "allRecommendationDetails": {
          "value": [
            {
              "averageUtilizationPercentage": 99.33,
              "benefitCost": 52.002,
              "commitmentAmount": 0.164,
              "coveragePercentage": 54.609,
              "overageCost": 144.841,
              "savingsAmount": 21.424,
              "savingsPercentage": 9.815,
              "totalCost": 196.843,
              "wastageCost": 0.035
            }
          ]
        },
        "armSkuName": "Compute_Savings_Plan",
        "commitmentGranularity": "Hourly",
        "costWithoutBenefit": 218.267,
        "currencyCode": "USD",
        "firstConsumptionDate": "2022-10-18T00:00:00Z",
        "lastConsumptionDate": "2022-10-25T00:00:00Z",
        "lookBackPeriod": "Last7Days",
        "recommendationDetails": {
          "averageUtilizationPercentage": 99.33,
          "benefitCost": 52.002,
          "commitmentAmount": 0.164,
          "coveragePercentage": 54.609,
          "overageCost": 144.841,
          "savingsAmount": 21.424,
          "savingsPercentage": 9.815,
          "totalCost": 196.843,
          "wastageCost": 0.035
        },
        "managementGroupId": "/providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-000000000001",
        "tenantId": "00000000-0000-0000-0000-000000000001",
        "scope": "ManagementGroup",
        "term": "P1Y",
        "totalHours": 168,
        "usage": {
          "charges": [
            1,
            1,
            0,
            1,
            1,
            1,
            1,
            1
          ],
          "usageGrain": "Hourly"
        }
      }
    }
  ]
}

Определения

Имя Описание
allSavingsBenefitDetails

Сведения о рекомендации по преимуществам.
allSavingsList

Список всех рекомендаций по преимуществам с подробными сведениями о рекомендации.
BenefitKind

Вид/тип пользы.
benefitRecommendationModel

Сведения о рекомендациях плана преимуществ.
benefitRecommendationsListResult

Результат перечисления рекомендаций по преимуществам.
createdByType

Тип учётной записи, создавшей ресурс.
ErrorDetails

Сведения об ошибке.
ErrorResponse

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. \n\nНекоторые ответы на ошибку: \n\n * 429 TooManyRequests — Запрос ограничен. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. \n\n * 503 СервисНедоступно - Связь временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.
Grain

Зерно, которое соответствует значению.
LookBackPeriod

Количество дней, когда я оглядывался назад.
managementGroupScopeBenefitRecommendationProperties

Свойства рекомендации по льготам при сфере действия — «ManageGroup».
recommendationUsageDetails

Плата по запросу между firstConsumptionDate и lastConsumptionDate, которые использовались для рекомендаций по преимуществам вычислений.
Scope

Что-то вроде возможности рекомендаций.
sharedScopeBenefitRecommendationProperties

Свойства рекомендации по преимуществу, если область является "Shared".
singleScopeBenefitRecommendationProperties

Свойства рекомендаций по преимуществам, если область — "Один".
systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.
Term

Зерно, которое соответствует значению.

allSavingsBenefitDetails

Объект

Сведения о рекомендации по преимуществам.

Имя Тип Описание
averageUtilizationPercentage

number (decimal)

Предполагаемый средний процент использования для "totalHours" в период обратной связи с этим обязательством.
benefitCost

number (decimal)

Предполагаемые затраты с преимуществом для "totalHours" в период оглядки. Это равно (обязательствоAmount * totalHours)
commitmentAmount

number (decimal)

Сумма обязательств по обязательствуGranularity.
coveragePercentage

number (decimal)

Предполагаемый процент покрытия пособий для "totalHours" в период обратного просмотра с этим обязательством.
overageCost

number (decimal)

Разница между общими затратами и преимуществами для "totalHours" в период обратного просмотра.
savingsAmount

number (decimal)

Сумма, сохраненная для "totalHours" в период оглядки, путем приобретения рекомендуемого количества преимущества.
savingsPercentage

number (decimal)

Экономия в процентах для "totalHours" в период оглядки, покупая рекомендуемое количество преимуществ.
totalCost

number (decimal)

Общая стоимость, которая является суммой стоимости преимущества и чрезмерной стоимости.
wastageCost

number (decimal)

Оценка неиспользуемой части "benefitCost".

allSavingsList

Объект

Список всех рекомендаций по преимуществам с подробными сведениями о рекомендации.

Имя Тип Описание
nextLink

string (uri)

Ссылка (URL-адрес) на следующую страницу результатов.
value

allSavingsBenefitDetails[]

Список рекомендаций по преимуществам с подробными сведениями о рекомендации..

BenefitKind

Перечисление

Вид/тип пользы.

Значение Описание
IncludedQuantity

Преимущество включается в составQuantity.
Reservation

Преимущество — резервирование.
SavingsPlan

Преимуществом является SavingsPlan.

benefitRecommendationModel

Объект

Сведения о рекомендациях плана преимуществ.

Имя Тип Описание
id

string (arm-id)

Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind

BenefitKind

Резервирование или сберегательный план.
name

string

Имя ресурса.
properties benefitRecommendationProperties:

Свойства рекомендаций по преимуществам.
systemData

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

Объект

Результат перечисления рекомендаций по преимуществам.

Имя Тип Описание
nextLink

string

Ссылка (URL-адрес) на следующую страницу результатов.
value

benefitRecommendationModel[]

Список рекомендаций по преимуществам.

createdByType

Перечисление

Тип учётной записи, создавшей ресурс.

Значение Описание
User
Application
ManagedIdentity
Key

ErrorDetails

Объект

Сведения об ошибке.

Имя Тип Описание
code

string

Код ошибки.
message

string

Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

ErrorResponse

Объект

Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. \n\nНекоторые ответы на ошибку: \n\n * 429 TooManyRequests — Запрос ограничен. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. \n\n * 503 СервисНедоступно - Связь временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.

Имя Тип Описание
error

ErrorDetails

Сведения об ошибке.

Grain

Перечисление

Зерно, которое соответствует значению.

Значение Описание
Hourly

Почасовое зерно соответствует значению в час.
Daily

Почасовое зерно соответствует значению в день.
Monthly

Почасовое зерно соответствует значению в месяц.

LookBackPeriod

Перечисление

Количество дней, когда я оглядывался назад.

Значение Описание
Last7Days

7 дней, используемых для того, чтобы оглядыться назад.
Last30Days

30 дней, используемых для того, чтобы оглядыться назад.
Last60Days

60 дней, используемых для того, чтобы оглядыться назад.

managementGroupScopeBenefitRecommendationProperties

Объект

Свойства рекомендации по льготам при сфере действия — «ManageGroup».

Имя Тип Описание
allRecommendationDetails

allSavingsList

Список всех рекомендаций по преимуществам с подробными сведениями о рекомендации.
armSkuName

string

Имя SKU ARM. "Compute_Savings_Plan" для SavingsPlan.
commitmentGranularity

Grain

Зерно предлагаемой суммы обязательств. Поддерживаемые значения: "Почасово"
costWithoutBenefit

number (decimal)

Текущая стоимость без льгот соответствует "totalHours" в период обратной стороны.
currencyCode

string

Идентификатор кода валюты ISO 4217 для затрат и сбережений.
firstConsumptionDate

string (date-time)

Первая дата использования, используемая для поиска рекомендаций.
lastConsumptionDate

string (date-time)

Дата последнего использования, используемая для вычисления рекомендаций.
lookBackPeriod

LookBackPeriod

Количество дней использования, вычисляемых для вычисления рекомендаций.
managementGroupId

string

Полностью квалифицированный идентификатор управленческой группы, для которой предназначена эта рекомендация по сфере деятельности, формата /providers/Microsoft. Management/managementGroups/{managementGroupId}. Применимо только если рекомендация относится к сфере «ManagementGroup».
recommendationDetails

allSavingsBenefitDetails

Подробные сведения о предлагаемой рекомендации.
scope string:

ManagementGroup

Область преимуществ. Например, один или общий доступ.
tenantId

string

Идентификатор арендатора, связанный с управляющей группой. Заполняется только при заполнении managementGroupId.
term

Term

Срок действия льготы. Например, P1Y или P3Y.
totalHours

integer (int32)

Общее количество часов, для которых распространяется стоимость. Его значение равно количеству записей в свойстве "properties/usage/charges".
usage

recommendationUsageDetails

Плата по запросу между firstConsumptionDate и lastConsumptionDate, которые использовались для рекомендаций по преимуществам вычислений.

recommendationUsageDetails

Объект

Плата по запросу между firstConsumptionDate и lastConsumptionDate, которые использовались для рекомендаций по преимуществам вычислений.

Имя Тип Описание
charges

number[] (decimal)

Плата за каждый час между firstConsumptionDate и lastConsumptionDate, которые использовались для рекомендаций по преимуществам вычислений.
usageGrain

Grain

Зерно использования. Поддерживаемые значения: "Почасово"

Scope

Перечисление

Что-то вроде возможности рекомендаций.

Значение Описание
Single

Рекомендация по одноформатному применению.
Shared

Рекомендация по общему объему.
ManagementGroup

Рекомендация по сфере деятельности управленческой группы.

sharedScopeBenefitRecommendationProperties

Объект

Свойства рекомендации по преимуществу, если область является "Shared".

Имя Тип Описание
allRecommendationDetails

allSavingsList

Список всех рекомендаций по преимуществам с подробными сведениями о рекомендации.
armSkuName

string

Имя SKU ARM. "Compute_Savings_Plan" для SavingsPlan.
commitmentGranularity

Grain

Зерно предлагаемой суммы обязательств. Поддерживаемые значения: "Почасово"
costWithoutBenefit

number (decimal)

Текущая стоимость без льгот соответствует "totalHours" в период обратной стороны.
currencyCode

string

Идентификатор кода валюты ISO 4217 для затрат и сбережений.
firstConsumptionDate

string (date-time)

Первая дата использования, используемая для поиска рекомендаций.
lastConsumptionDate

string (date-time)

Дата последнего использования, используемая для вычисления рекомендаций.
lookBackPeriod

LookBackPeriod

Количество дней использования, вычисляемых для вычисления рекомендаций.
recommendationDetails

allSavingsBenefitDetails

Подробные сведения о предлагаемой рекомендации.
scope string:

Shared

Область преимуществ. Например, один или общий доступ.
term

Term

Срок действия льготы. Например, P1Y или P3Y.
totalHours

integer (int32)

Общее количество часов, для которых распространяется стоимость. Его значение равно количеству записей в свойстве "properties/usage/charges".
usage

recommendationUsageDetails

Плата по запросу между firstConsumptionDate и lastConsumptionDate, которые использовались для рекомендаций по преимуществам вычислений.

singleScopeBenefitRecommendationProperties

Объект

Свойства рекомендаций по преимуществам, если область — "Один".

Имя Тип Описание
allRecommendationDetails

allSavingsList

Список всех рекомендаций по преимуществам с подробными сведениями о рекомендации.
armSkuName

string

Имя SKU ARM. "Compute_Savings_Plan" для SavingsPlan.
commitmentGranularity

Grain

Зерно предлагаемой суммы обязательств. Поддерживаемые значения: "Почасово"
costWithoutBenefit

number (decimal)

Текущая стоимость без льгот соответствует "totalHours" в период обратной стороны.
currencyCode

string

Идентификатор кода валюты ISO 4217 для затрат и сбережений.
firstConsumptionDate

string (date-time)

Первая дата использования, используемая для поиска рекомендаций.
lastConsumptionDate

string (date-time)

Дата последнего использования, используемая для вычисления рекомендаций.
lookBackPeriod

LookBackPeriod

Количество дней использования, вычисляемых для вычисления рекомендаций.
recommendationDetails

allSavingsBenefitDetails

Подробные сведения о предлагаемой рекомендации.
resourceGroup

string

Группа ресурсов, для которую указана эта рекомендация по одной области. Применимо только в том случае, если рекомендация относится к области запроса Single и ResourceGroup.
scope string:

Single

Область преимуществ. Например, один или общий доступ.
subscriptionId

string

Идентификатор подписки, для этой рекомендации по одной области. Применимо только в том случае, если рекомендация относится к области "Один".
term

Term

Срок действия льготы. Например, P1Y или P3Y.
totalHours

integer (int32)

Общее количество часов, для которых распространяется стоимость. Его значение равно количеству записей в свойстве "properties/usage/charges".
usage

recommendationUsageDetails

Плата по запросу между firstConsumptionDate и lastConsumptionDate, которые использовались для рекомендаций по преимуществам вычислений.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).
createdBy

string

Идентификатор, создавший ресурс.
createdByType

createdByType

Тип учётной записи, создавшей ресурс.
lastModifiedAt

string (date-time)

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.
lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.

Term

Перечисление

Зерно, которое соответствует значению.

Значение Описание
P1Y

Срок льгот составляет 1 год.
P3Y

Срок льгот составляет 3 года.