Benefit Recommendations - List

Referencia

Service:: Cost Management

API Version:: 2023-11-01

A megtakarítási csomag megvásárlására vonatkozó javaslatok listája.

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-paraméterek

Name	In	Kötelező	Típus	Description
billingScope	path	True	string	A juttatás-javaslati műveletekhez társított hatókör. Ide tartozik a "/subscriptions/{subscriptionId}/" az előfizetés hatóköréhez, a "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" erőforráscsoport-hatókörhöz, a /providers/Microsoft.Billing/billingAccounts/{billingAccountId}" a nagyvállalati szerződés hatóköréhez, valamint a "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" a számlázási profil hatóköréhez
api-version	query	True	string	A művelethez használandó API-verzió.
$expand	query		string	A tulajdonságok kibontására használható: properties/usage, properties/allRecommendationDetails
$filter	query		string	A benefitRecommendations szűréséhez használható a következő szerint: properties/scope, allowed values ,Single", "Shared" és default value 'Shared'; és properties/lookBackPeriod engedélyezett értékekkel :Last7Days", "Last30Days", "Last60Days" és alapértelmezett "Last60Days"; properties/term with allowed values "P1Y", "P3Y" és default value "P3Y"; properties/subscriptionId; properties/resourceGroup
$orderby	query		string	A javaslatok a következő sorrendben rendelhetők meg: properties/armSkuName. A megtakarítási csomag esetében az eredmények alapértelmezés szerint sorrendben vannak. Ezt a záradékot nem kell használni.

Válaszok

Name	Típus	Description
200 OK	benefitRecommendationsListResult	OK gombra. A kérés sikeres volt.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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
            }
          ]
        }
      }
    }
  ]
}

Definíciók

Name	Description
allSavingsBenefitDetails	Juttatási javaslat részletei.
allSavingsList	Az összes előnyjavaslat listája a javaslat részleteivel.
benefitKind	Reservation vagy SavingsPlan.
benefitRecommendationModel	juttatási csomagra vonatkozó javaslatok részletei.
benefitRecommendationsListResult	A listázási előnyökre vonatkozó javaslatok eredménye.
ErrorDetails	A hiba részletei.
ErrorResponse	A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg. Néhány hibaválasz: 429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "x-ms-ratelimit-microsoft.consumption-retry-after" fejlécben megadott időpontra való várakozás után. 503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Várjon a „Retry-After” fejlécben megadott ideig, majd próbálkozzon újra.
grain	A használat szemcséje. Támogatott értékek: "Óránként"
lookBackPeriod	A javaslatok kiszámításához kiértékelt napok száma.
recommendationUsageDetails	A firstConsumptionDate és a lastConsumptionDate közötti igény szerinti díjak, amelyeket a számítási előnyökre vonatkozó javaslatokhoz használtak.
sharedScopeBenefitRecommendationProperties	Az előnyjavaslat tulajdonságai, ha a hatókör "Megosztott".
singleScopeBenefitRecommendationProperties	Az előnyjavaslatok tulajdonságai, ha a hatókör "Single".
term	Az előny időtartama. Például P1Y vagy P3Y.

allSavingsBenefitDetails

Juttatási javaslat részletei.

Name	Típus	Description
averageUtilizationPercentage	number	A "totalHours" becsült átlagos kihasználtsági százaléka a visszatekintési időszakban, ezzel a kötelezettségvállalással.
benefitCost	number	A "totalHours" becsült költsége a visszatekintési időszakban. Egyenlő (commitmentAmount * totalHours)
commitmentAmount	number	A kötelezettségvállalás összege a commitmentGranularity értéken.
coveragePercentage	number	A "totalHours" becsült haszonfedettségi százaléka a visszatekintési időszakban, ezzel a kötelezettségvállalással.
overageCost	number	A "totalHours" teljes költségének és juttatási költségének különbsége a visszatekintési időszakban.
savingsAmount	number	A "totalHours" számára a visszatekintési időszakban megtakarított összeg az előny ajánlott mennyiségének megvásárlásával.
savingsPercentage	number	A "totalHours" százalékos megtakarítása a visszatekintési időszakban a javasolt haszonmennyiség megvásárlásával.
totalCost	number	Teljes költség, amely a juttatási költség és a túlhasználati költség összege.
wastageCost	number	A "benefitCost" becsült fel nem használt része.

allSavingsList

Az összes előnyjavaslat listája a javaslat részleteivel.

Name	Típus	Description
nextLink	string	Az eredmény következő oldalára mutató hivatkozás (URL- cím).
value	allSavingsBenefitDetails[]	Az előnyökre vonatkozó javaslatok listája a javaslat részleteivel.

benefitKind

Reservation vagy SavingsPlan.

Name	Típus	Description
IncludedQuantity	string	Az előny a IncludedQuantity.
Reservation	string	Az előny a Foglalás.
SavingsPlan	string	Az előny a SavingsPlan.

benefitRecommendationModel

juttatási csomagra vonatkozó javaslatok részletei.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Reservation vagy SavingsPlan.
name	string	Az erőforrás neve
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	Az előnyökre vonatkozó javaslatok tulajdonságai.
type	string	Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

A listázási előnyökre vonatkozó javaslatok eredménye.

Name	Típus	Description
nextLink	string	Az eredmény következő oldalára mutató hivatkozás (URL- cím).
value	benefitRecommendationModel[]	A juttatási javaslatok listája.

ErrorDetails

A hiba részletei.

Name	Típus	Description
code	string	Hibakód.
message	string	Hibaüzenet jelzi, hogy a művelet miért nem sikerült.

ErrorResponse

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Néhány hibaválasz:

429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "x-ms-ratelimit-microsoft.consumption-retry-after" fejlécben megadott időpontra való várakozás után.
503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Várjon a „Retry-After” fejlécben megadott ideig, majd próbálkozzon újra.

Name	Típus	Description
error	ErrorDetails	A hiba részletei.

grain

A használat szemcséje. Támogatott értékek: "Óránként"

Name	Típus	Description
Daily	string	Az óránkénti szemcse napi értéknek felel meg.
Hourly	string	Az óránkénti szemcse az óránkénti értéknek felel meg.
Monthly	string	Az óránkénti szemcse a havi értéknek felel meg.

lookBackPeriod

A javaslatok kiszámításához kiértékelt napok száma.

Name	Típus	Description
Last30Days	string	30 nap volt hátranézni.
Last60Days	string	60 nap volt hátranézni.
Last7Days	string	7 nap a visszatekintéshez.

recommendationUsageDetails

A firstConsumptionDate és a lastConsumptionDate közötti igény szerinti díjak, amelyeket a számítási előnyökre vonatkozó javaslatokhoz használtak.

Name	Típus	Description
charges	number[]	A számítási előnyökre vonatkozó javaslatokhoz használt firstConsumptionDate és lastConsumptionDate közötti óránkénti igény szerinti díjak.
usageGrain	grain	A használat szemcséje. Támogatott értékek: "Óránként"

sharedScopeBenefitRecommendationProperties

Az előnyjavaslat tulajdonságai, ha a hatókör "Megosztott".

Name	Típus	Description
allRecommendationDetails	allSavingsList	Az összes előnyjavaslat listája a javaslat részleteivel.
armSkuName	string	ARM-termékváltozat neve. "Compute_Savings_Plan" a SavingsPlan esetében.
commitmentGranularity	grain	A tervezett kötelezettségvállalási összeg szemcséje. Támogatott értékek: "Óránként"
costWithoutBenefit	number	Az aktuális költség előny nélkül a visszatekintési időszakban a "totalHours" értéknek felel meg.
currencyCode	string	A költségek és megtakarítások összegének ISO 4217-es pénznemkód-azonosítója.
firstConsumptionDate	string	Az első használati dátum, amelyet a javaslatok kiszámításához használt visszatekintéshez.
lastConsumptionDate	string	A javaslatok kiszámításához használt utolsó használati dátum.
lookBackPeriod	lookBackPeriod	A javaslatok kiszámításához kiértékelt napok száma.
recommendationDetails	allSavingsBenefitDetails	A javasolt javaslat részletei.
scope	string: Shared	Juttatás hatóköre. Például egyszemélyes vagy megosztott.
term	term	Az előny időtartama. Például P1Y vagy P3Y.
totalHours	integer	Az a teljes óra, amelyre a költségeket fedezik. Egyenlő a "properties/usage/charges" tulajdonság rekordjainak számával.
usage	recommendationUsageDetails	A firstConsumptionDate és a lastConsumptionDate közötti igény szerinti díjak, amelyeket a számítási előnyökre vonatkozó javaslatokhoz használtak.

singleScopeBenefitRecommendationProperties

Az előnyjavaslatok tulajdonságai, ha a hatókör "Single".

Name	Típus	Description
allRecommendationDetails	allSavingsList	Az összes előnyjavaslat listája a javaslat részleteivel.
armSkuName	string	ARM-termékváltozat neve. "Compute_Savings_Plan" a SavingsPlan esetében.
commitmentGranularity	grain	A tervezett kötelezettségvállalási összeg szemcséje. Támogatott értékek: "Óránként"
costWithoutBenefit	number	Az aktuális költség előny nélkül a visszatekintési időszakban a "totalHours" értéknek felel meg.
currencyCode	string	A költségek és megtakarítások összegének ISO 4217-es pénznemkód-azonosítója.
firstConsumptionDate	string	Az első használati dátum, amelyet a javaslatok kiszámításához használt visszatekintéshez.
lastConsumptionDate	string	A javaslatok kiszámításához használt utolsó használati dátum.
lookBackPeriod	lookBackPeriod	A javaslatok kiszámításához kiértékelt napok száma.
recommendationDetails	allSavingsBenefitDetails	A javasolt javaslat részletei.
resourceGroup	string	Az egyetlen hatókörre vonatkozó javaslat erőforráscsoportja. Csak akkor alkalmazható, ha a javaslat az "önálló" és a "ResourceGroup" kérelem hatókörére vonatkozik.
scope	string: Single	Juttatás hatóköre. Például egyszemélyes vagy megosztott.
subscriptionId	string	Az előfizetés azonosítója, amelyhez ez az egyetlen hatókör-javaslat tartozik. Csak akkor alkalmazható, ha a javaslat "önálló" hatókörre vonatkozik.
term	term	Az előny időtartama. Például P1Y vagy P3Y.
totalHours	integer	Az a teljes óra, amelyre a költségeket fedezik. Egyenlő a "properties/usage/charges" tulajdonság rekordjainak számával.
usage	recommendationUsageDetails	A firstConsumptionDate és a lastConsumptionDate közötti igény szerinti díjak, amelyeket a számítási előnyökre vonatkozó javaslatokhoz használtak.

term

Az előny időtartama. Például P1Y vagy P3Y.

Name	Típus	Description
P1Y	string	A juttatás időtartama 1 év.
P3Y	string	A juttatás időtartama 3 év.