Benefit Recommendations - List

Reference

Služba:: Cost Management

Verze rozhraní API:: 2024-08-01

Seznam doporučení pro nákupní plán úspor

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
billingScope	path	True	string	Rozsah přidružený k operacím doporučení výhod. Patří sem předplatné /subscriptions/{subscriptionId}/' pro rozsah předplatného, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}, pro rozsah skupiny prostředků /providers/Microsoft.Billing/billingAccounts/{billingAccountId} pro rozsah smlouvy Enterprise a /providers/Microsoft.Billing/billingAccounts/{billingAccounts}/billingProfiles/{billingProfileId} pro rozsah fakturačního profilu.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
$expand	query		string	Lze použít k rozšíření vlastností podle: properties/usage, properties/allRecommendationDetails
$filter	query		string	Lze použít k filtrování benefitRecommendations podle: properties/scope with allowed values ['Single', 'Shared'] and default value 'Shared'; a properties/lookBackPeriod s povolenými hodnotami ['Last7Days', 'Last30Days', 'Last60Days'] a výchozí hodnotou Last60Days; properties/term with allowed values ['P1Y', 'P3Y'] and default value 'P3Y'; properties/subscriptionId; properties/resourceGroup
$orderby	query		string	Dá se použít k seřazení doporučení podle: properties/armSkuName. U plánu úspor jsou výsledky ve výchozím nastavení v pořadí. Tuto klauzuli není nutné používat.

Odpovědi

Name	Typ	Description
200 OK	benefitRecommendationsListResult	OK. Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

BenefitRecommendationsBillingAccountList

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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
            }
          ]
        }
      }
    }
  ]
}

Definice

Name	Description
allSavingsBenefitDetails	Podrobnosti o doporučení výhod.
allSavingsList	Seznam všech doporučení výhod s podrobnostmi o doporučení.
benefitKind	Reservation or SavingsPlan.
benefitRecommendationModel	podrobnosti o doporučení plánu benefitů
benefitRecommendationsListResult	Výsledek výpisu doporučení výhod
ErrorDetails	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě. Některé chybové odpovědi: 429 TooManyRequests – Požadavek je omezený. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.
grain	Podrobné informace o využití. Podporované hodnoty: Hourly
lookBackPeriod	Počet dnů využití vyhodnocených pro výpočet doporučení.
recommendationUsageDetails	Poplatky na vyžádání mezi firstConsumptionDate a lastConsumptionDate, které se použily pro doporučení k výpočetním výhodám.
sharedScopeBenefitRecommendationProperties	Vlastnosti doporučení k výhodě, pokud je obor Sdílený.
singleScopeBenefitRecommendationProperties	Vlastnosti doporučení výhod, pokud je rozsah "Single".
term	Období výhody. Například P1Y nebo P3Y.

allSavingsBenefitDetails

Podrobnosti o doporučení výhod.

Name	Typ	Description
averageUtilizationPercentage	number	Odhadované procento průměrného využití "totalHours" v období zpětného vyhledávání s tímto závazkem.
benefitCost	number	Odhadované náklady s výhodami pro "celkový počet hodin" v období zpětného vyhledávání. Rovná se (commitmentAmount * totalHours)
commitmentAmount	number	Částka závazku na závazkuGranularity.
coveragePercentage	number	Odhadované procento pokrytí výhod pro "totalHours" v období zpětného vyhledávání s tímto závazkem.
overageCost	number	Rozdíl mezi celkovými náklady a náklady na zvýhodnění pro "totalHours" v období zpětného vyhledávání.
savingsAmount	number	Částka uložená za "totalHours" v období zpětného vyhledávání nákupem doporučeného množství výhody.
savingsPercentage	number	Úspory v procentech "totalHours" v období zpětného vyhledávání nákupem doporučeného množství výhod.
totalCost	number	Celkové náklady, což je součet nákladů na zvýhodnění a nadlimitních nákladů.
wastageCost	number	Odhadovaná nevyužitá část "benefitCost".

allSavingsList

Seznam všech doporučení výhod s podrobnostmi o doporučení.

Name	Typ	Description
nextLink	string	Odkaz (URL) na další stránku výsledků.
value	allSavingsBenefitDetails[]	Seznam doporučení výhod s podrobnostmi o doporučení.

benefitKind

Reservation or SavingsPlan.

Name	Typ	Description
IncludedQuantity	string	Benefit je IncludedQuantity.
Reservation	string	Výhoda je Rezervace.
SavingsPlan	string	Benefit je SavingsPlan.

benefitRecommendationModel

podrobnosti o doporučení plánu benefitů

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Reservation or SavingsPlan.
name	string	Název prostředku
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	Vlastnosti doporučení výhod.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

benefitRecommendationsListResult

Výsledek výpisu doporučení výhod

Name	Typ	Description
nextLink	string	Odkaz (URL) na další stránku výsledků.
value	benefitRecommendationModel[]	Seznam doporučení výhod.

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ErrorResponse

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Některé chybové odpovědi:

429 TooManyRequests – Požadavek je omezený. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě.

grain

Podrobné informace o využití. Podporované hodnoty: Hourly

Name	Typ	Description
Daily	string	Hodinová agregační hodnota odpovídá hodnotě za den.
Hourly	string	Hodinová agregační hodnota odpovídá hodnotě za hodinu.
Monthly	string	Hodinová agregační hodnota odpovídá hodnotě za měsíc.

lookBackPeriod

Počet dnů využití vyhodnocených pro výpočet doporučení.

Name	Typ	Description
Last30Days	string	30 dní se na to podívali.
Last60Days	string	60 dní se k návratu.
Last7Days	string	7 dní se k návratu.

recommendationUsageDetails

Poplatky na vyžádání mezi firstConsumptionDate a lastConsumptionDate, které se použily pro doporučení k výpočetním výhodám.

Name	Typ	Description
charges	number[]	Poplatky na vyžádání za každou hodinu mezi firstConsumptionDate a lastConsumptionDate, které se používaly pro doporučení pro výpočetní výhody.
usageGrain	grain	Podrobné informace o využití. Podporované hodnoty: Hourly

sharedScopeBenefitRecommendationProperties

Vlastnosti doporučení k výhodě, pokud je obor Sdílený.

Name	Typ	Description
allRecommendationDetails	allSavingsList	Seznam všech doporučení výhod s podrobnostmi o doporučení.
armSkuName	string	Název skladové položky ARM "Compute_Savings_Plan" pro SavingsPlan.
commitmentGranularity	grain	Agregace navrhované částky závazku. Podporované hodnoty: Hourly
costWithoutBenefit	number	Aktuální náklady bez zvýhodnění odpovídají celkovému počtu hodin v období zpětného vyhledávání.
currencyCode	string	Identifikátor kódu měny ISO 4217 pro náklady a částky úspor.
firstConsumptionDate	string	První datum použití použité k vyhledání doporučení.
lastConsumptionDate	string	Poslední datum použití použité k vyhledání doporučení.
lookBackPeriod	lookBackPeriod	Počet dnů využití vyhodnocených pro výpočet doporučení.
recommendationDetails	allSavingsBenefitDetails	Podrobnosti navrhovaného doporučení.
scope	string: Shared	Rozsah výhod. Například Jeden nebo Sdílený.
term	term	Období výhody. Například P1Y nebo P3Y.
totalHours	integer	Celková doba, po kterou se náklady vztahují. Je roven počtu záznamů ve vlastnosti properties/usage/charges.
usage	recommendationUsageDetails	Poplatky na vyžádání mezi firstConsumptionDate a lastConsumptionDate, které se použily pro doporučení k výpočetním výhodám.

singleScopeBenefitRecommendationProperties

Vlastnosti doporučení výhod, pokud je rozsah "Single".

Name	Typ	Description
allRecommendationDetails	allSavingsList	Seznam všech doporučení výhod s podrobnostmi o doporučení.
armSkuName	string	Název skladové položky ARM "Compute_Savings_Plan" pro SavingsPlan.
commitmentGranularity	grain	Agregace navrhované částky závazku. Podporované hodnoty: Hourly
costWithoutBenefit	number	Aktuální náklady bez zvýhodnění odpovídají celkovému počtu hodin v období zpětného vyhledávání.
currencyCode	string	Identifikátor kódu měny ISO 4217 pro náklady a částky úspor.
firstConsumptionDate	string	První datum použití použité k vyhledání doporučení.
lastConsumptionDate	string	Poslední datum použití použité k vyhledání doporučení.
lookBackPeriod	lookBackPeriod	Počet dnů využití vyhodnocených pro výpočet doporučení.
recommendationDetails	allSavingsBenefitDetails	Podrobnosti navrhovaného doporučení.
resourceGroup	string	Skupina prostředků, pro kterou se doporučuje tento jediný obor. Platí pouze v případě, že doporučení platí pro obor single a obor požadavku ResourceGroup.
scope	string: Single	Rozsah výhod. Například Jeden nebo Sdílený.
subscriptionId	string	ID předplatného, pro které je toto doporučení pro jeden obor. Platí pouze v případě, že doporučení je pro obor Single.
term	term	Období výhody. Například P1Y nebo P3Y.
totalHours	integer	Celková doba, po kterou se náklady vztahují. Je roven počtu záznamů ve vlastnosti properties/usage/charges.
usage	recommendationUsageDetails	Poplatky na vyžádání mezi firstConsumptionDate a lastConsumptionDate, které se použily pro doporučení k výpočetním výhodám.

term

Období výhody. Například P1Y nebo P3Y.

Name	Typ	Description
P1Y	string	Období benefitu je 1 rok.
P3Y	string	Období benefitu je 3 roky.

Sdílet prostřednictvím