Benefit Recommendations - List

Service:

Cost Management

API-versie:

2023-11-01

Lijst met aanbevelingen voor het kopen van een spaarplan.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
billingScope	path	True	string	Het bereik dat is gekoppeld aan bewerkingen voor aanbevelingen voor voordelen. Dit omvat '/subscriptions/{subscriptionId}/' voor abonnementsbereik, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} voor resourcegroepsbereik, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' voor Enterprise Agreement-bereik 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 breiden met: properties/usage, properties/allRecommendationDetails
$filter	query		string	Kan worden gebruikt om benefitRecommendations te filteren op: eigenschappen/bereik met toegestane waarden ['Enkel', 'Gedeeld'] en standaardwaarde 'Gedeeld'; and properties/lookBackPeriod met toegestane waarden ['Last7Days', 'Last30Days', 'Last60Days'] en de 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 staan de resultaten standaard op 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-stroom.

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=2023-11-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 voordelenaanbeveling met de details van de aanbeveling.
benefitKind	Reservering of SavingsPlan.
benefitRecommendationModel	details van de aanbeveling voor een voordeelplan.
benefitRecommendationsListResult	Resultaat van het weergeven 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 wordt 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 net zolang hebt gewacht zoals aangegeven in de header 'Retry-After'.
grain	De korrel van het gebruik. Ondersteunde waarden: 'Per uur'
lookBackPeriod	Het aantal dagen gebruik dat is geëvalueerd voor het berekenen van de aanbevelingen.
recommendationUsageDetails	Kosten op aanvraag tussen firstConsumptionDate en lastConsumptionDate die zijn gebruikt voor het berekenen van aanbevelingen voor voordelen.
sharedScopeBenefitRecommendationProperties	De eigenschappen van de aanbeveling voor voordelen wanneer het bereik 'Gedeeld' is.
singleScopeBenefitRecommendationProperties	De eigenschappen van de voordelenaanbeveling 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 terugblikperiode, met deze toezegging.
benefitCost	number	De geschatte kosten met baten voor de 'totalHours' in de terugblikperiode. Het is gelijk aan (commitmentAmount * totalHours)
commitmentAmount	number	Het toezeggingsbedrag op de commitmentGranularity.
coveragePercentage	number	Geschat dekkingspercentage van voordelen voor de 'totalHours' in de terugblikperiode, met deze toezegging.
overageCost	number	Het verschil tussen totale kosten en batenkosten voor de 'totalHours' in de terugblikperiode.
savingsAmount	number	Het bedrag dat is bespaard voor de 'totalHours' in de terugblikperiode, door de aanbevolen hoeveelheid van het voordeel aan te schaffen.
savingsPercentage	number	De besparing in percentage voor de 'totalHours' in de terugblikperiode, door de aanbevolen hoeveelheid voordeel aan te schaffen.
totalCost	number	Totale kosten, dit is de som van de batenkosten en overschrijdingskosten.
wastageCost	number	Geschatte ongebruikte gedeelte van de 'benefitCost'.

allSavingsList

De lijst met alle voordelenaanbeveling 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 voordelenaanbeveling met de aanbevelingsdetails.

benefitKind

Reservering of SavingsPlan.

Name	Type	Description
IncludedQuantity	string	Het voordeel is IncludedQuantity.
Reservation	string	Het voordeel is Reservering.
SavingsPlan	string	Het voordeel is SavingsPlan.

benefitRecommendationModel

details van de aanbeveling 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 SavingsPlan.
name	string	De naam van de resource
properties	benefitRecommendationProperties: sharedScopeBenefitRecommendationProperties singleScopeBenefitRecommendationProperties	De eigenschappen van de voordelenaanbeveling.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

benefitRecommendationsListResult

Resultaat van het weergeven 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 waarin wordt aangegeven waarom de bewerking is mislukt.

ErrorResponse

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden wordt 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 net zolang hebt gewacht zoals aangegeven in de header 'Retry-After'.

Name	Type	Description
error	ErrorDetails	De details van de fout.

grain

De korrel van het gebruik. Ondersteunde waarden: 'Per uur'

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

lookBackPeriod

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

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

recommendationUsageDetails

Kosten op aanvraag tussen firstConsumptionDate en lastConsumptionDate die zijn gebruikt voor het berekenen van aanbevelingen voor voordelen.

Name	Type	Description
charges	number[]	Kosten op aanvraag voor elk uur tussen firstConsumptionDate en lastConsumptionDate die zijn gebruikt voor het berekenen van aanbevelingen voor voordelen.
usageGrain	grain	De korrel van het gebruik. Ondersteunde waarden: 'Per uur'

sharedScopeBenefitRecommendationProperties

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

Name	Type	Description
allRecommendationDetails	allSavingsList	De lijst met alle voordelenaanbeveling met de details van de aanbeveling.
armSkuName	string	ARM-SKU-naam. 'Compute_Savings_Plan' voor SavingsPlan.
commitmentGranularity	grain	Korrel van het voorgestelde toezeggingsbedrag. Ondersteunde waarden: 'Per uur'
costWithoutBenefit	number	De huidige kosten zonder voordeel komen overeen met 'totalHours' in de terugblikperiode.
currencyCode	string	Een ISO 4217-valutacode-id voor de kosten- en besparingsbedragen.
firstConsumptionDate	string	De eerste gebruiksdatum die wordt gebruikt om terug te kijken voor het berekenen van de aanbevelingen.
lastConsumptionDate	string	De laatste gebruiksdatum die is gebruikt om terug te kijken voor het berekenen van de aanbevelingen.
lookBackPeriod	lookBackPeriod	Het aantal dagen gebruik dat is 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 'eigenschappen/gebruik/kosten'.
usage	recommendationUsageDetails	Kosten op aanvraag tussen firstConsumptionDate en lastConsumptionDate die zijn gebruikt voor het berekenen van aanbevelingen voor voordelen.

singleScopeBenefitRecommendationProperties

De eigenschappen van de voordelenaanbeveling wanneer het bereik 'Enkel' is.

Name	Type	Description
allRecommendationDetails	allSavingsList	De lijst met alle voordelenaanbeveling met de details van de aanbeveling.
armSkuName	string	ARM-SKU-naam. 'Compute_Savings_Plan' voor SavingsPlan.
commitmentGranularity	grain	Korrel van het voorgestelde toezeggingsbedrag. Ondersteunde waarden: 'Per uur'
costWithoutBenefit	number	De huidige kosten zonder voordeel komen overeen met 'totalHours' in de terugblikperiode.
currencyCode	string	Een ISO 4217-valutacode-id voor de kosten- en besparingsbedragen.
firstConsumptionDate	string	De eerste gebruiksdatum die wordt gebruikt om terug te kijken voor het berekenen van de aanbevelingen.
lastConsumptionDate	string	De laatste gebruiksdatum die is gebruikt om terug te kijken voor het berekenen van de aanbevelingen.
lookBackPeriod	lookBackPeriod	Het aantal dagen gebruik dat is 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 betrekking heeft op het aanvraagbereik 'Single' en 'ResourceGroup'.
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 betrekking heeft op het bereik 'Eén'.
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 'eigenschappen/gebruik/kosten'.
usage	recommendationUsageDetails	Kosten op aanvraag tussen firstConsumptionDate en lastConsumptionDate die zijn gebruikt voor het berekenen van aanbevelingen voor voordelen.

term

Termijn van het voordeel. Bijvoorbeeld P1Y of P3Y.

Name	Type	Description
P1Y	string	De uitkeringstermijn is 1 jaar.
P3Y	string	De uitkeringstermijn is 3 jaar.