Condividi tramite

Benefit Recommendations - List

  • Riferimento
Servizio:
Cost Management
Versione API:
2024-08-01

Elenco di raccomandazioni per il piano di risparmio per l'acquisto.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
billingScope
 path True

string

Ambito associato alle operazioni di raccomandazione sui vantaggi. Sono inclusi '/subscriptions/{subscriptionId}/' per l'ambito della sottoscrizione, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' per l'ambito del gruppo di risorse, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' per l'ambito del contratto Enterprise e '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfileId}' per l'ambito del profilo di fatturazione
api-version
 query True

string

Versione dell'API da usare per questa operazione.
$expand
 query

string

Può essere usato per espandere le proprietà in base a: proprietà/utilizzo, proprietà/allRecommendationDetails
$filter
 query

string

Può essere usato per filtrare benefitRecommendations by: properties/scope con valori consentiti ['Single', 'Shared'] e valore predefinito 'Shared'; proprietà e /lookBackPeriod con valori consentiti ['Last7Days', 'Last30Days', 'Last60Days'] e valore predefinito 'Last60Days'; proprietà/termine con valori consentiti ['P1Y', 'P3Y'] e valore predefinito 'P3Y'; properties/subscriptionId; properties/resourceGroup
$orderby
 query

string

Può essere usato per ordinare le raccomandazioni in base a: proprietà/armSkuName. Per il piano di risparmio, i risultati sono in ordine per impostazione predefinita. Non è necessario usare questa clausola.

Risposte

Nome Tipo Descrizione
200 OK

benefitRecommendationsListResult

OK. La richiesta ha avuto esito positivo.
Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

BenefitRecommendationsBillingAccountList

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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
            }
          ]
        }
      }
    }
  ]
}

Definizioni

Nome Descrizione
allSavingsBenefitDetails

Dettagli delle raccomandazioni per i vantaggi.
allSavingsList

Elenco di tutte le raccomandazioni sui vantaggi con i dettagli della raccomandazione.
benefitKind

Prenotazione o risparmioPlan.
benefitRecommendationModel

Dettagli della raccomandazione del piano benefit.
benefitRecommendationsListResult

Risultato delle raccomandazioni relative ai vantaggi dell'inserzione.
ErrorDetails

Dettagli dell'errore.
ErrorResponse

La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Alcune risposte di errore:

  • 429 TooManyRequests - La richiesta è limitata. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".
grain

Granularità dell'utilizzo. Valori supportati: 'Hourly'
lookBackPeriod

Numero di giorni di utilizzo valutati per il calcolo delle raccomandazioni.
recommendationUsageDetails

Addebiti su richiesta tra firstConsumptionDate e lastConsumptionDate usati per le raccomandazioni relative ai vantaggi del calcolo.
sharedScopeBenefitRecommendationProperties

Le proprietà della raccomandazione del vantaggio quando l'ambito è "Condiviso".
singleScopeBenefitRecommendationProperties

Le proprietà dei consigli sui vantaggi quando l'ambito è "Single".
term

Periodo di tempo del vantaggio. Ad esempio, P1Y o P3Y.

allSavingsBenefitDetails

Dettagli delle raccomandazioni per i vantaggi.

Nome Tipo Descrizione
averageUtilizationPercentage

number

Percentuale di utilizzo media stimata per il "totalHours" nel periodo di ricerca, con questo impegno.
benefitCost

number

Il costo stimato con vantaggio per il "totalHours" nel periodo di ricerca. È uguale a (commitmentAmount * totalHours)
commitmentAmount

number

Importo dell'impegno in corrispondenza dell'impegnoGranularity.
coveragePercentage

number

Percentuale stimata di copertura dei benefici per il "totalHours" nel periodo di ricerca, con questo impegno.
overageCost

number

Differenza tra il costo totale e il costo dei benefici per il "totalHours" nel periodo di ricerca.
savingsAmount

number

L'importo risparmiato per il "totalHours" nel periodo di ricerca, acquistando la quantità consigliata del vantaggio.
savingsPercentage

number

Il risparmio in percentuale per il "totalHours" nel periodo di ricerca, acquistando la quantità consigliata di beneficio.
totalCost

number

Costo totale, che è la somma dei costi di vantaggio e dei costi di eccedenza.
wastageCost

number

Parte non utilizzata stimata di "benefitCost".

allSavingsList

Elenco di tutte le raccomandazioni sui vantaggi con i dettagli della raccomandazione.

Nome Tipo Descrizione
nextLink

string

Collegamento (URL) alla pagina successiva dei risultati.
value

allSavingsBenefitDetails[]

Elenco di raccomandazioni sui vantaggi con i dettagli della raccomandazione.

benefitKind

Prenotazione o risparmioPlan.

Nome Tipo Descrizione
IncludedQuantity

string

Il vantaggio è IncludedQuantity.
Reservation

string

Il vantaggio è Prenotazione.
SavingsPlan

string

Il vantaggio è SavingsPlan.

benefitRecommendationModel

Dettagli della raccomandazione del piano benefit.

Nome Tipo Descrizione
id

string

ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

benefitKind

Prenotazione o risparmioPlan.
name

string

Nome della risorsa
properties benefitRecommendationProperties:

Proprietà delle raccomandazioni per i vantaggi.
type

string

Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

benefitRecommendationsListResult

Risultato delle raccomandazioni relative ai vantaggi dell'inserzione.

Nome Tipo Descrizione
nextLink

string

Collegamento (URL) alla pagina successiva dei risultati.
value

benefitRecommendationModel[]

Elenco di raccomandazioni sui vantaggi.

ErrorDetails

Dettagli dell'errore.

Nome Tipo Descrizione
code

string

Codice di errore.
message

string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

ErrorResponse

La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Alcune risposte di errore:

  • 429 TooManyRequests - La richiesta è limitata. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".

Nome Tipo Descrizione
error

ErrorDetails

Dettagli dell'errore.

grain

Granularità dell'utilizzo. Valori supportati: 'Hourly'

Nome Tipo Descrizione
Daily

string

La granularità oraria corrisponde al valore al giorno.
Hourly

string

La granularità oraria corrisponde al valore all'ora.
Monthly

string

La granularità oraria corrisponde al valore al mese.

lookBackPeriod

Numero di giorni di utilizzo valutati per il calcolo delle raccomandazioni.

Nome Tipo Descrizione
Last30Days

string

30 giorni usati per guardare indietro.
Last60Days

string

60 giorni usati per guardare indietro.
Last7Days

string

7 giorni usati per guardare indietro.

recommendationUsageDetails

Addebiti su richiesta tra firstConsumptionDate e lastConsumptionDate usati per le raccomandazioni relative ai vantaggi del calcolo.

Nome Tipo Descrizione
charges

number[]

Addebiti su richiesta per ogni ora tra firstConsumptionDate e lastConsumptionDate usati per le raccomandazioni relative ai vantaggi di calcolo.
usageGrain

grain

Granularità dell'utilizzo. Valori supportati: 'Hourly'

sharedScopeBenefitRecommendationProperties

Le proprietà della raccomandazione del vantaggio quando l'ambito è "Condiviso".

Nome Tipo Descrizione
allRecommendationDetails

allSavingsList

Elenco di tutte le raccomandazioni sui vantaggi con i dettagli della raccomandazione.
armSkuName

string

Nome SKU arm. 'Compute_Savings_Plan' per SavingsPlan.
commitmentGranularity

grain

Grana dell'importo dell'impegno proposto. Valori supportati: 'Hourly'
costWithoutBenefit

number

Il costo corrente senza vantaggio corrisponde a "totalHours" nel periodo di ricerca.
currencyCode

string

Identificatore del codice di valuta ISO 4217 per i costi e gli importi di risparmio.
firstConsumptionDate

string

La prima data di utilizzo usata per cercare di calcolare le raccomandazioni.
lastConsumptionDate

string

Data dell'ultimo utilizzo usata per cercare di calcolare le raccomandazioni.
lookBackPeriod

lookBackPeriod

Numero di giorni di utilizzo valutati per il calcolo delle raccomandazioni.
recommendationDetails

allSavingsBenefitDetails

Dettagli della raccomandazione proposta.
scope string:

Shared

Ambito del vantaggio. Ad esempio, Single o Shared.
term

term

Periodo di tempo del vantaggio. Ad esempio, P1Y o P3Y.
totalHours

integer

Ore totali per le quali viene coperto il costo. Uguale al numero di record in una proprietà 'proprietà/utilizzo/addebiti'.
usage

recommendationUsageDetails

Addebiti su richiesta tra firstConsumptionDate e lastConsumptionDate usati per le raccomandazioni relative ai vantaggi del calcolo.

singleScopeBenefitRecommendationProperties

Le proprietà dei consigli sui vantaggi quando l'ambito è "Single".

Nome Tipo Descrizione
allRecommendationDetails

allSavingsList

Elenco di tutte le raccomandazioni sui vantaggi con i dettagli della raccomandazione.
armSkuName

string

Nome SKU arm. 'Compute_Savings_Plan' per SavingsPlan.
commitmentGranularity

grain

Grana dell'importo dell'impegno proposto. Valori supportati: 'Hourly'
costWithoutBenefit

number

Il costo corrente senza vantaggio corrisponde a "totalHours" nel periodo di ricerca.
currencyCode

string

Identificatore del codice di valuta ISO 4217 per i costi e gli importi di risparmio.
firstConsumptionDate

string

La prima data di utilizzo usata per cercare di calcolare le raccomandazioni.
lastConsumptionDate

string

Data dell'ultimo utilizzo usata per cercare di calcolare le raccomandazioni.
lookBackPeriod

lookBackPeriod

Numero di giorni di utilizzo valutati per il calcolo delle raccomandazioni.
recommendationDetails

allSavingsBenefitDetails

Dettagli della raccomandazione proposta.
resourceGroup

string

Il gruppo di risorse per cui è consigliata questa singola raccomandazione per l'ambito. Applicabile solo se la raccomandazione è relativa all'ambito di richiesta 'Single' e 'ResourceGroup'.
scope string:

Single

Ambito del vantaggio. Ad esempio, Single o Shared.
subscriptionId

string

L'ID sottoscrizione per cui è consigliata questa singola raccomandazione per l'ambito. Applicabile solo se la raccomandazione è relativa all'ambito "Single".
term

term

Periodo di tempo del vantaggio. Ad esempio, P1Y o P3Y.
totalHours

integer

Ore totali per le quali viene coperto il costo. Uguale al numero di record in una proprietà 'proprietà/utilizzo/addebiti'.
usage

recommendationUsageDetails

Addebiti su richiesta tra firstConsumptionDate e lastConsumptionDate usati per le raccomandazioni relative ai vantaggi del calcolo.

term

Periodo di tempo del vantaggio. Ad esempio, P1Y o P3Y.

Nome Tipo Descrizione
P1Y

string

Il periodo di validità del vantaggio è 1 anno.
P3Y

string

Il termine del beneficio è di 3 anni.