Benefit Recommendations - List

Ссылка

Служба:: Cost Management

Версия API:: 2024-08-01

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

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

С использованием необязательных параметров:

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

Параметры 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	Версия 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	ХОРОШО. Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

BenefitRecommendationsBillingAccountList

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

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=2024-08-01

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

Код состояния:: 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	Резервирование или сберегательный план.
benefitRecommendationModel	Сведения о рекомендациях плана преимуществ.
benefitRecommendationsListResult	Результат перечисления рекомендаций по преимуществам.
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. Некоторые ответы на ошибки: 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable — служба временно недоступна. Повторите попытку после ожидания времени, указанного в заголовке Retry-After.
grain	Зерно использования. Поддерживаемые значения: "Почасово"
lookBackPeriod	Количество дней использования, вычисляемых для вычисления рекомендаций.
recommendationUsageDetails	Плата по запросу между firstConsumptionDate и lastConsumptionDate, которые использовались для рекомендаций по преимуществам вычислений.
sharedScopeBenefitRecommendationProperties	Свойства рекомендации по преимуществу, если область является "Shared".
singleScopeBenefitRecommendationProperties	Свойства рекомендаций по преимуществам, если область — "Один".
term	Срок действия льготы. Например, P1Y или P3Y.

allSavingsBenefitDetails

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

Имя	Тип	Описание
averageUtilizationPercentage	number	Предполагаемый средний процент использования для "totalHours" в период обратной связи с этим обязательством.
benefitCost	number	Предполагаемые затраты с преимуществом для "totalHours" в период оглядки. Это равно (обязательствоAmount * totalHours)
commitmentAmount	number	Сумма обязательств по обязательствуGranularity.
coveragePercentage	number	Предполагаемый процент покрытия пособий для "totalHours" в период обратного просмотра с этим обязательством.
overageCost	number	Разница между общими затратами и преимуществами для "totalHours" в период обратного просмотра.
savingsAmount	number	Сумма, сохраненная для "totalHours" в период оглядки, путем приобретения рекомендуемого количества преимущества.
savingsPercentage	number	Экономия в процентах для "totalHours" в период оглядки, покупая рекомендуемое количество преимуществ.
totalCost	number	Общая стоимость, которая является суммой стоимости преимущества и чрезмерной стоимости.
wastageCost	number	Оценка неиспользуемой части "benefitCost".

allSavingsList

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

Имя	Тип	Описание
nextLink	string	Ссылка (URL-адрес) на следующую страницу результатов.
value	allSavingsBenefitDetails[]	Список рекомендаций по преимуществам с подробными сведениями о рекомендации..

benefitKind

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

Имя	Тип	Описание
IncludedQuantity	string	Преимущество включается в составQuantity.
Reservation	string	Преимущество — резервирование.
SavingsPlan	string	Преимуществом является SavingsPlan.

benefitRecommendationModel

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

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Резервирование или сберегательный план.
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

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

Имя	Тип	Описание
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	Зерно использования. Поддерживаемые значения: "Почасово"

sharedScopeBenefitRecommendationProperties

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

Имя	Тип	Описание
allRecommendationDetails	allSavingsList	Список всех рекомендаций по преимуществам с подробными сведениями о рекомендации.
armSkuName	string	Имя SKU ARM. "Compute_Savings_Plan" для SavingsPlan.
commitmentGranularity	grain	Зерно предлагаемой суммы обязательств. Поддерживаемые значения: "Почасово"
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

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

Имя	Тип	Описание
allRecommendationDetails	allSavingsList	Список всех рекомендаций по преимуществам с подробными сведениями о рекомендации.
armSkuName	string	Имя SKU ARM. "Compute_Savings_Plan" для SavingsPlan.
commitmentGranularity	grain	Зерно предлагаемой суммы обязательств. Поддерживаемые значения: "Почасово"
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.

Имя	Тип	Описание
P1Y	string	Срок льгот составляет 1 год.
P3Y	string	Срок льгот составляет 3 года.

Поделиться через