Benefit Recommendations - List

  • Referens
Tjänst:
Cost Management
API-version:
2024-08-01

Lista över rekommendationer för köp av sparplan.

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

URI-parametrar

Name I Obligatorisk Typ Description
billingScope
 path True

string

Omfånget som är associerat med åtgärder för förmånsrekommendationsåtgärder. Detta inkluderar "/subscriptions/{subscriptionId}/" för prenumerationsomfång, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' för resursgruppsomfång, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' för enterprise-avtalsomfång och '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} för faktureringsprofilomfång
api-version
 query True

string

DEN API-version som ska användas för den här åtgärden.
$expand
 query

string

Kan användas för att expandera egenskaperna efter: egenskaper/användning, egenskaper/allRecommendationDetails
$filter
 query

string

Kan användas för att filtrera benefitRecommendations av: egenskaper/omfång med tillåtna värden ['Single', 'Shared'] och standardvärdet 'Shared'; och egenskaper/lookBackPeriod med tillåtna värden ['Last7Days', 'Last30Days', 'Last60Days'] och standardvärdet 'Last60Days'; egenskaper/term med tillåtna värden ['P1Y', 'P3Y'] och standardvärdet 'P3Y'; properties/subscriptionId; properties/resourceGroup
$orderby
 query

string

Kan användas för att beställa rekommendationerna efter: properties/armSkuName. För sparplanen är resultatet i ordning som standard. Du behöver inte använda den här satsen.

Svar

Name Typ Description
200 OK

benefitRecommendationsListResult

OKEJ. Begäran har slutförts.
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

BenefitRecommendationsBillingAccountList

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
allSavingsBenefitDetails

Information om förmånsrekommendationer.
allSavingsList

Listan över alla förmånsrekommendationer med rekommendationsinformationen.
benefitKind

Reservation eller SavingsPlan.
benefitRecommendationModel

information om rekommendationen för förmånsplanen.
benefitRecommendationsListResult

Resultat av att lista förmånsrekommendationer.
ErrorDetails

Information om felet.
ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".
grain

Användningsintervallet. Värden som stöds: "Varje timme"
lookBackPeriod

Antalet dagar av användning som utvärderats för att beräkna rekommendationerna.
recommendationUsageDetails

Avgifter på begäran mellan firstConsumptionDate och lastConsumptionDate som användes för rekommendationer för beräkningsförmån.
sharedScopeBenefitRecommendationProperties

Egenskaperna för förmånsrekommenditeten när omfånget är Delat.
singleScopeBenefitRecommendationProperties

Egenskaperna för förmånsrekommendationerna när omfånget är "Single".
term

Förmånens period. Till exempel P1Y eller P3Y.

allSavingsBenefitDetails

Information om förmånsrekommendationer.

Name Typ Description
averageUtilizationPercentage

number

Uppskattad genomsnittlig användningsprocent för "totalHours" under look-back-perioden, med det här åtagandet.
benefitCost

number

Den beräknade kostnaden med förmån för "totalHours" under look-back-perioden. Det är lika med (commitmentAmount * totalHours)
commitmentAmount

number

Åtagandebeloppet för åtagandetGranularitet.
coveragePercentage

number

Uppskattad procentuell förmånstäckning för "totalHours" under återblicksperioden, med detta åtagande.
overageCost

number

Skillnaden mellan den totala kostnaden och förmånskostnaden för "totalHours" under look-back-perioden.
savingsAmount

number

Det belopp som sparats för "totalHours" under look-back-perioden genom att köpa den rekommenderade kvantiteten av förmånen.
savingsPercentage

number

Besparingar i procent för "totalHours" under återblicksperioden genom att köpa den rekommenderade förmånskvantiteten.
totalCost

number

Total kostnad, vilket är summan av förmånskostnaden och överförbrukningskostnaden.
wastageCost

number

Uppskattad oanvänd del av "benefitCost".

allSavingsList

Listan över alla förmånsrekommendationer med rekommendationsinformationen.

Name Typ Description
nextLink

string

Länken (URL) till nästa resultatsida.
value

allSavingsBenefitDetails[]

Listan över förmånsrekommendationer med rekommendationsinformationen..

benefitKind

Reservation eller SavingsPlan.

Name Typ Description
IncludedQuantity

string

Förmånen är IncludedQuantity.
Reservation

string

Förmånen är Reservation.
SavingsPlan

string

Förmånen är SavingsPlan.

benefitRecommendationModel

information om rekommendationen för förmånsplanen.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

benefitKind

Reservation eller SavingsPlan.
name

string

Namnet på resursen
properties benefitRecommendationProperties:

Egenskaperna för förmånsrekommendationerna.
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

Resultat av att lista förmånsrekommendationer.

Name Typ Description
nextLink

string

Länken (URL) till nästa resultatsida.
value

benefitRecommendationModel[]

Listan över förmånsrekommendationer.

ErrorDetails

Information om felet.

Name Typ Description
code

string

Felkod.
message

string

Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".

Name Typ Description
error

ErrorDetails

Information om felet.

grain

Användningsintervallet. Värden som stöds: "Varje timme"

Name Typ Description
Daily

string

Timintervall motsvarar värdet per dag.
Hourly

string

Timintervall motsvarar värdet per timme.
Monthly

string

Timintervall motsvarar värdet per månad.

lookBackPeriod

Antalet dagar av användning som utvärderats för att beräkna rekommendationerna.

Name Typ Description
Last30Days

string

30 dagar brukade se tillbaka.
Last60Days

string

60 dagar brukade se tillbaka.
Last7Days

string

7 dagar brukade se tillbaka.

recommendationUsageDetails

Avgifter på begäran mellan firstConsumptionDate och lastConsumptionDate som användes för rekommendationer för beräkningsförmån.

Name Typ Description
charges

number[]

Avgifter på begäran för varje timme mellan firstConsumptionDate och lastConsumptionDate som användes för rekommendationer för beräkningsförmån.
usageGrain

grain

Användningsintervallet. Värden som stöds: "Varje timme"

sharedScopeBenefitRecommendationProperties

Egenskaperna för förmånsrekommenditeten när omfånget är Delat.

Name Typ Description
allRecommendationDetails

allSavingsList

Listan över alla förmånsrekommendationer med rekommendationsinformationen.
armSkuName

string

ARM SKU-namn. "Compute_Savings_Plan" för SavingsPlan.
commitmentGranularity

grain

Korn för det föreslagna åtagandebeloppet. Värden som stöds: "Varje timme"
costWithoutBenefit

number

Den aktuella kostnaden utan förmån motsvarar "totalHours" under look-back-perioden.
currencyCode

string

En ISO 4217-valutakodidentifierare för kostnader och sparbelopp.
firstConsumptionDate

string

Det första användningsdatumet som används för att se tillbaka för att beräkna rekommendationerna.
lastConsumptionDate

string

Det senaste användningsdatumet som används för att se tillbaka för att beräkna rekommendationerna.
lookBackPeriod

lookBackPeriod

Antalet dagar av användning som utvärderats för att beräkna rekommendationerna.
recommendationDetails

allSavingsBenefitDetails

Detaljerna i den föreslagna rekommendationen.
scope string:

Shared

Förmånsomfång. Till exempel Enkel eller Delad.
term

term

Förmånens period. Till exempel P1Y eller P3Y.
totalHours

integer

Det totala antalet timmar som kostnaden täcks för. Det är lika med antalet poster i en egenskap "egenskaper/användning/avgifter".
usage

recommendationUsageDetails

Avgifter på begäran mellan firstConsumptionDate och lastConsumptionDate som användes för rekommendationer för beräkningsförmån.

singleScopeBenefitRecommendationProperties

Egenskaperna för förmånsrekommendationerna när omfånget är "Single".

Name Typ Description
allRecommendationDetails

allSavingsList

Listan över alla förmånsrekommendationer med rekommendationsinformationen.
armSkuName

string

ARM SKU-namn. "Compute_Savings_Plan" för SavingsPlan.
commitmentGranularity

grain

Korn för det föreslagna åtagandebeloppet. Värden som stöds: "Varje timme"
costWithoutBenefit

number

Den aktuella kostnaden utan förmån motsvarar "totalHours" under look-back-perioden.
currencyCode

string

En ISO 4217-valutakodidentifierare för kostnader och sparbelopp.
firstConsumptionDate

string

Det första användningsdatumet som används för att se tillbaka för att beräkna rekommendationerna.
lastConsumptionDate

string

Det senaste användningsdatumet som används för att se tillbaka för att beräkna rekommendationerna.
lookBackPeriod

lookBackPeriod

Antalet dagar av användning som utvärderats för att beräkna rekommendationerna.
recommendationDetails

allSavingsBenefitDetails

Detaljerna i den föreslagna rekommendationen.
resourceGroup

string

Den resursgrupp som den här rekommendationen om enskilt omfång är till för. Gäller endast om rekommendationen gäller för omfånget "Single" och "ResourceGroup".
scope string:

Single

Förmånsomfång. Till exempel Enkel eller Delad.
subscriptionId

string

Det prenumerations-ID som den här rekommendationen om enstaka omfång gäller. Gäller endast om rekommendationen gäller för omfånget "Enskild".
term

term

Förmånens period. Till exempel P1Y eller P3Y.
totalHours

integer

Det totala antalet timmar som kostnaden täcks för. Det är lika med antalet poster i en egenskap "egenskaper/användning/avgifter".
usage

recommendationUsageDetails

Avgifter på begäran mellan firstConsumptionDate och lastConsumptionDate som användes för rekommendationer för beräkningsförmån.

term

Förmånens period. Till exempel P1Y eller P3Y.

Name Typ Description
P1Y

string

Förmånsperioden är 1 år.
P3Y

string

Förmånsperioden är 3 år.