Benefit Recommendations - List

Service:

Cost Management

API-versie:

2024-08-01

Lijst met aanbevelingen voor het aankoopbesparingsplan.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
billingScope	path	True	string	Het bereik dat is gekoppeld aan aanbevelingsbewerkingen voor voordelen. Dit omvat '/subscriptions/{subscriptionId}/' voor abonnementsbereik, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} voor het bereik van de resourcegroep, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' voor het bereik van de enterprise-overeenkomst en /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor het bereik van het factureringsprofiel
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
$expand	query		string	Kan worden gebruikt om de eigenschappen uit te vouwen op: properties/usage, properties/allRecommendationDetails
$filter	query		string	Kan worden gebruikt om benefitRecommendations te filteren op: properties/scope with allowed values ['Single', 'Shared'] en standaardwaarde 'Shared'; en eigenschappen/lookBackPeriod met toegestane waarden ['Last7Days', 'Last30Days', 'Last60Days'] en standaardwaarde 'Last60Days'; eigenschappen/term met toegestane waarden ['P1Y', 'P3Y'] en standaardwaarde 'P3Y'; properties/subscriptionId; properties/resourceGroup
$orderby	query		string	Kan worden gebruikt om de aanbevelingen te ordenen op: properties/armSkuName. Voor het spaarplan zijn de resultaten standaard in volgorde. U hoeft deze component niet te gebruiken.

Antwoorden

Name	Type	Description
200 OK	benefitRecommendationsListResult	OK. De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

BenefitRecommendationsBillingAccountList

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
allSavingsBenefitDetails	Details van de aanbeveling voor voordelen.
allSavingsList	De lijst met alle aanbevelingen voor voordelen met de details van de aanbeveling.
benefitKind	Reservering of Spaarplan.
benefitRecommendationModel	Details van aanbevelingen voor een voordeelplan.
benefitRecommendationsListResult	Resultaat van het vermelden van aanbevelingen voor voordelen.
ErrorDetails	De details van de fout.
ErrorResponse	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht. Enkele foutberichten: 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.
grain	Het korreltje van het gebruik. Ondersteunde waarden: 'Elk uur'
lookBackPeriod	Het aantal dagen dat het gebruik wordt geëvalueerd voor het berekenen van de aanbevelingen.
recommendationUsageDetails	On-demand kosten tussen firstConsumptionDate en lastConsumptionDate die zijn gebruikt voor aanbevelingen voor computingvoordelen.
sharedScopeBenefitRecommendationProperties	De eigenschappen van de aanbeveling voor voordelen wanneer het bereik Gedeeld is.
singleScopeBenefitRecommendationProperties	De eigenschappen van de aanbevelingen voor voordelen wanneer het bereik 'Enkel' is.
term	Termijn van het voordeel. Bijvoorbeeld P1Y of P3Y.

allSavingsBenefitDetails

Details van de aanbeveling voor voordelen.

Name	Type	Description
averageUtilizationPercentage	number	Geschat gemiddeld gebruikspercentage voor de totalHours in de look-backperiode, met deze toezegging.
benefitCost	number	De geschatte kosten met voordeel voor de 'totalHours' in de look-backperiode. Het is gelijk aan (commitmentAmount * totalHours)
commitmentAmount	number	Het toezeggingsbedrag op de commitmentGranularity.
coveragePercentage	number	Geschat voordeeldekkingspercentage voor de totalHours in de look-backperiode, met deze toezegging.
overageCost	number	Het verschil tussen totale kosten en batenkosten voor de 'totalHours' in de look-backperiode.
savingsAmount	number	Het bedrag dat is bespaard voor de totalHours in de look-backperiode, door de aanbevolen hoeveelheid van het voordeel te kopen.
savingsPercentage	number	De besparingen in percentage voor de totalHours in de look-backperiode door de aanbevolen hoeveelheid voordeel aan te schaffen.
totalCost	number	Totale kosten, wat de som is van de batenkosten en overschrijdingskosten.
wastageCost	number	Geschatte ongebruikte gedeelte van de 'benefitCost'.

allSavingsList

De lijst met alle aanbevelingen voor voordelen met de details van de aanbeveling.

Name	Type	Description
nextLink	string	De koppeling (URL) naar de volgende pagina met resultaten.
value	allSavingsBenefitDetails[]	De lijst met aanbevelingen voor voordelen met de details van de aanbeveling.

benefitKind

Reservering of Spaarplan.

Name	Type	Description
IncludedQuantity	string	Benefit is IncludedQuantity.
Reservation	string	Voordeel is Reservering.
SavingsPlan	string	Voordeel is SavingsPlan.

benefitRecommendationModel

Details van aanbevelingen voor een voordeelplan.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	benefitKind	Reservering of Spaarplan.
name	string	De naam van de resource
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	De eigenschappen van de aanbevelingen voor voordelen.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

benefitRecommendationsListResult

Resultaat van het vermelden van aanbevelingen voor voordelen.

Name	Type	Description
nextLink	string	De koppeling (URL) naar de volgende pagina met resultaten.
value	benefitRecommendationModel[]	De lijst met aanbevelingen voor voordelen.

ErrorDetails

De details van de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponse

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden is opgegeven in het foutbericht.

Enkele foutberichten:

• 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header x-ms-ratelimit-microsoft.consumption-retry-after.

• 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.

Name	Type	Description
error	ErrorDetails	De details van de fout.

grain

Het korreltje van het gebruik. Ondersteunde waarden: 'Elk uur'

Name	Type	Description
Daily	string	Elk uur komt overeen met de waarde per dag.
Hourly	string	Elk uur komt overeen met de waarde per uur.
Monthly	string	Elk uur komt overeen met de waarde per maand.

lookBackPeriod

Het aantal dagen dat het gebruik wordt geëvalueerd voor het berekenen van de aanbevelingen.

Name	Type	Description
Last30Days	string	30 dagen om terug te kijken.
Last60Days	string	60 dagen terugkijken.
Last7Days	string	7 dagen om terug te kijken.

recommendationUsageDetails

On-demand kosten tussen firstConsumptionDate en lastConsumptionDate die zijn gebruikt voor aanbevelingen voor computingvoordelen.

Name	Type	Description
charges	number[]	Kosten op aanvraag voor elk uur tussen firstConsumptionDate en lastConsumptionDate die zijn gebruikt voor aanbevelingen voor computingvoordelen.
usageGrain	grain	Het korreltje van het gebruik. Ondersteunde waarden: 'Elk uur'

sharedScopeBenefitRecommendationProperties

De eigenschappen van de aanbeveling voor voordelen wanneer het bereik Gedeeld is.

Name	Type	Description
allRecommendationDetails	allSavingsList	De lijst met alle aanbevelingen voor voordelen met de details van de aanbeveling.
armSkuName	string	NAAM VAN ARM-SKU. 'Compute_Savings_Plan' voor SavingsPlan.
commitmentGranularity	grain	Korrel van het voorgestelde toezeggingsbedrag. Ondersteunde waarden: 'Elk uur'
costWithoutBenefit	number	De huidige kosten zonder voordeel komen overeen met 'totalHours' in de look-backperiode.
currencyCode	string	Een ISO 4217-valutacode-id voor de kosten en besparingen.
firstConsumptionDate	string	De eerste gebruiksdatum die wordt gebruikt voor het berekenen van de aanbevelingen.
lastConsumptionDate	string	De laatste gebruiksdatum die wordt gebruikt om terug te kijken naar het berekenen van de aanbevelingen.
lookBackPeriod	lookBackPeriod	Het aantal dagen dat het gebruik wordt geëvalueerd voor het berekenen van de aanbevelingen.
recommendationDetails	allSavingsBenefitDetails	De details van de voorgestelde aanbeveling.
scope	string: Shared	Voordeelbereik. Bijvoorbeeld Enkel of Gedeeld.
term	term	Termijn van het voordeel. Bijvoorbeeld P1Y of P3Y.
totalHours	integer	Het totale aantal uren waarvoor de kosten worden gedekt. Het is gelijk aan het aantal records in een eigenschap 'properties/usage/charges'.
usage	recommendationUsageDetails	On-demand kosten tussen firstConsumptionDate en lastConsumptionDate die zijn gebruikt voor aanbevelingen voor computingvoordelen.

singleScopeBenefitRecommendationProperties

De eigenschappen van de aanbevelingen voor voordelen wanneer het bereik 'Enkel' is.

Name	Type	Description
allRecommendationDetails	allSavingsList	De lijst met alle aanbevelingen voor voordelen met de details van de aanbeveling.
armSkuName	string	NAAM VAN ARM-SKU. 'Compute_Savings_Plan' voor SavingsPlan.
commitmentGranularity	grain	Korrel van het voorgestelde toezeggingsbedrag. Ondersteunde waarden: 'Elk uur'
costWithoutBenefit	number	De huidige kosten zonder voordeel komen overeen met 'totalHours' in de look-backperiode.
currencyCode	string	Een ISO 4217-valutacode-id voor de kosten en besparingen.
firstConsumptionDate	string	De eerste gebruiksdatum die wordt gebruikt voor het berekenen van de aanbevelingen.
lastConsumptionDate	string	De laatste gebruiksdatum die wordt gebruikt om terug te kijken naar het berekenen van de aanbevelingen.
lookBackPeriod	lookBackPeriod	Het aantal dagen dat het gebruik wordt geëvalueerd voor het berekenen van de aanbevelingen.
recommendationDetails	allSavingsBenefitDetails	De details van de voorgestelde aanbeveling.
resourceGroup	string	De resourcegroep waarvoor deze aanbeveling voor één bereik is bedoeld. Alleen van toepassing als de aanbeveling voor het aanvraagbereik 'Enkel' en 'ResourceGroup' is.
scope	string: Single	Voordeelbereik. Bijvoorbeeld Enkel of Gedeeld.
subscriptionId	string	De abonnements-id waarvoor deze aanbeveling voor één bereik is bedoeld. Alleen van toepassing als de aanbeveling voor 'Enkel' bereik is.
term	term	Termijn van het voordeel. Bijvoorbeeld P1Y of P3Y.
totalHours	integer	Het totale aantal uren waarvoor de kosten worden gedekt. Het is gelijk aan het aantal records in een eigenschap 'properties/usage/charges'.
usage	recommendationUsageDetails	On-demand kosten tussen firstConsumptionDate en lastConsumptionDate die zijn gebruikt voor aanbevelingen voor computingvoordelen.

term

Termijn van het voordeel. Bijvoorbeeld P1Y of P3Y.

Name	Type	Description
P1Y	string	De looptijd van het voordeel is 1 jaar.
P3Y	string	De looptijd van het voordeel is 3 jaar.