Benefit Recommendations - List

Referencia

Szolgáltatás:: Cost Management

API-verzió:: 2024-08-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=2024-08-01

Opcionális paraméterekkel:

GET https://management.azure.com/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations?$filter={$filter}&$orderby={$orderby}&$expand={$expand}&api-version=2024-08-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 tartoznak a nagyvállalati szerződés hatóköréhez tartozó "/subscriptions/{subscriptionId}/" előfizetési hatókör, az erőforráscsoport-hatókörhöz tartozó "/subscriptionId}/{resourceGroups/{resourceGroupName}", a nagyvállalati szerződés hatóköréhez tartozó "/subscriptions/{billingAccountId}", a számlázási profil hatóköréhez pedig a "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}".
api-version	query	True	string	A művelethez használni kívánt 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ére használható: tulajdonságok/hatókör engedélyezett értékekkel :Single", "Shared" és default value "Shared"; és tulajdonságok/lookBackPeriod engedélyezett értékekkel :Last7Days", "Last30Days", "Last60Days" és alapértelmezett "Last60Days"; tulajdonságok/kifejezés engedélyezett értékekkel :P1Y", "P3Y" és alapértelmezett "P3Y"; properties/subscriptionId; properties/resourceGroup
$orderby	query		string	A javaslatok a következő sorrendben rendelhetők meg: properties/armSkuName. A megtakarítási terv 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É. A kérés sikeres volt.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

Példák

BenefitRecommendationsBillingAccountList

Mintakérelem

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

Mintaválasz

Állapotkó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
            }
          ]
        }
      }
    }
  ]
}

Definíciók

Name	Description
allSavingsBenefitDetails	Juttatási javaslat részletei.
allSavingsList	Az összes juttatási javaslat listája a javaslat részleteivel.
benefitKind	Foglalás vagy SavingsPlan.
benefitRecommendationModel	juttatási csomagra vonatkozó javaslat részletei.
benefitRecommendationsListResult	A listázási juttatásra 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őre való várakozás után. 503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Próbálkozzon újra az "Újrapróbálkozás után" fejlécben megadott időre való várakozás után.
grain	A használat szemcséje. Támogatott értékek: "Óránként"
lookBackPeriod	A javaslatok kiszámításához kiértékelt használati napok száma.
recommendationUsageDetails	Az elsőConsumptionDate é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	A juttatási javaslat tulajdonságai, ha a hatókör "Megosztott".
singleScopeBenefitRecommendationProperties	A juttatási javaslatok tulajdonságai, ha a hatókör "Önálló".
term	A juttatás 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 juttatási lefedettségének százalékos aránya a visszatekintési időszakban, ezzel a kötelezettségvállalással.
overageCost	number	A visszatekintési időszakban a "totalHours" teljes költségének és juttatási költségének különbsége.
savingsAmount	number	A visszatekintési időszakban a "totalHours" értékhez 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, az előny ajánlott mennyiségének 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 juttatási javaslat listája a javaslat részleteivel.

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

benefitKind

Foglalás vagy SavingsPlan.

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

benefitRecommendationModel

juttatási csomagra vonatkozó javaslat 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	Foglalás vagy SavingsPlan.
name	string	Az erőforrás neve
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	A juttatási javaslatok tulajdonságai.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

A listázási juttatásra vonatkozó javaslatok eredménye.

Name	Típus	Description
nextLink	string	Az eredmények 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	A művelet sikertelen voltát jelző hibaüzenet.

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őre való várakozás után.
503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Próbálkozzon újra az "Újrapróbálkozás után" fejlécben megadott időre való várakozás után.

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 szemcsék óránkénti értéknek felelnek meg.
Monthly	string	Az óránkénti gabona havi értéknek felel meg.

lookBackPeriod

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

Name	Típus	Description
Last30Days	string	30 nap, hogy visszatekintsünk.
Last60Days	string	60 nap, hogy visszatekintsünk.
Last7Days	string	7 nap a visszatekintéshez.

recommendationUsageDetails

Az elsőConsumptionDate é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

A juttatási javaslat tulajdonságai, ha a hatókör "Megosztott".

Name	Típus	Description
allRecommendationDetails	allSavingsList	Az összes juttatási javaslat listája a javaslat részleteivel.
armSkuName	string	ARM-termékváltozat neve. "Compute_Savings_Plan" a SavingsPlanhoz.
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 juttatás 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	A javaslatok kiszámításához használt első használati dátum.
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 használati 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	A juttatás időtartama. Például P1Y vagy P3Y.
totalHours	integer	Az a teljes óraszám, amelyre a költség vonatkozik. Egyenlő a "properties/usage/charges" tulajdonság rekordjainak számával.
usage	recommendationUsageDetails	Az elsőConsumptionDate é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

A juttatási javaslatok tulajdonságai, ha a hatókör "Önálló".

Name	Típus	Description
allRecommendationDetails	allSavingsList	Az összes juttatási javaslat listája a javaslat részleteivel.
armSkuName	string	ARM-termékváltozat neve. "Compute_Savings_Plan" a SavingsPlanhoz.
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 juttatás 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	A javaslatok kiszámításához használt első használati dátum.
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 használati napok száma.
recommendationDetails	allSavingsBenefitDetails	A javasolt javaslat részletei.
resourceGroup	string	Az az erőforráscsoport, amelyre ez az egyetlen hatókörre vonatkozó javaslat tartozik. 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	A juttatás időtartama. Például P1Y vagy P3Y.
totalHours	integer	Az a teljes óraszám, amelyre a költség vonatkozik. Egyenlő a "properties/usage/charges" tulajdonság rekordjainak számával.
usage	recommendationUsageDetails	Az elsőConsumptionDate é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

A juttatás 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.

Megosztás a következőn keresztül: