Reservation Recommendation Details - Get

Riferimento

Servizio:: Consumption

Versione API:: 2024-08-01

Dettagli di una raccomandazione di prenotazione per l'analisi di simulazione delle istanze riservate.

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope={scope}&region={region}&term={term}&lookBackPeriod={lookBackPeriod}&product={product}

Con parametri facoltativi:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope={scope}&region={region}&term={term}&lookBackPeriod={lookBackPeriod}&product={product}&$filter={$filter}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceScope	path	True	string	Ambito associato alle operazioni di dettagli della raccomandazione di prenotazione. 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 ambito BillingAccount e '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' per l'ambito billingProfile
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione corrente è 2023-03-01.
lookBackPeriod	query	True	lookBackPeriod	Filtrare il periodo di tempo in base al quale si basano i risultati delle raccomandazioni di prenotazione.
product	query	True	string	Filtrare i prodotti per i quali vengono generati i risultati delle raccomandazioni di prenotazione. Esempi: Standard_DS1_v2 (per macchina virtuale), Premium_SSD_Managed_Disks_P30 (per Managed Disks)
region	query	True	string	Usato per selezionare l'area per cui deve essere generata la raccomandazione.
scope	query	True	scope	Ambito della prenotazione.
term	query	True	term	Specificare la lunghezza del termine di raccomandazione per la prenotazione.
$filter	query		string	Usato per filtrare i dettagli delle raccomandazioni di prenotazione in base a: le proprietà/subscriptionId possono essere specificate per i percorsi dell'account di fatturazione e del profilo di fatturazione.

Risposte

Nome	Tipo	Descrizione
200 OK	ReservationRecommendationDetailsModel	OK. La richiesta ha avuto esito positivo.
204 No Content		Quando non sono presenti dettagli di raccomandazione, viene inviata una risposta vuota.
Other Status Codes	HighCasedErrorResponse	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

ReservationRecommendationsByBillingAccount-Legacy

ReservationRecommendationsByBillingProfile-Modern

ReservationRecommendationsByResourceGroup-Legacy

ReservationRecommendationsBySubscription-Legacy

ReservationRecommendationsByBillingAccount-Legacy

Esempio di richiesta

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope=Shared&region=eastus&term=P1Y&lookBackPeriod=Last60Days&product=Standard_DS14_v2&$filter=properties/subscriptionId eq 00000000-0000-0000-0000-00000000

Risposta di esempio

Codice di stato:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/00000000/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "USD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000",
        "00000000-0000-0000-0000-00000000"
      ],
      "onDemandRate": 1.482,
      "product": "Standard_DS14_v2",
      "region": "eastus",
      "reservationRate": 0.70570776255707,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": null,
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 529550.326618951,
          "overageCost": 63253.5935111345,
          "quantity": 220,
          "reservationCost": 223102.452054792,
          "totalReservationCost": 286356.045565927,
          "savings": 243194.281053024
        },
        {
          "onDemandCost": 529550.32661895,
          "overageCost": 149335.025050147,
          "quantity": 179,
          "reservationCost": 181524.267808217,
          "totalReservationCost": 330859.292858364,
          "savings": 198691.033760586
        },
        {
          "onDemandCost": 529550.32661895,
          "overageCost": 195942.319606957,
          "quantity": 157,
          "reservationCost": 159214.022602738,
          "totalReservationCost": 355156.342209695,
          "savings": 174393.984409255
        },
        {
          "onDemandCost": 529550.32661895,
          "overageCost": 30975.2311896299,
          "quantity": 241,
          "reservationCost": 244398.595205477,
          "totalReservationCost": 275373.826395107,
          "savings": 254176.500223843
        }
      ],
      "lookBackPeriod": 60,
      "recommendedQuantity": 253,
      "reservationOrderTerm": "P1Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Shared",
    "usage": {
      "firstConsumptionDate": "2019-11-27T00:00:00",
      "lastConsumptionDate": "2020-01-25T21:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        275.95003899999995,
        275.916705,
        276,
        276,
        275.916725,
        275.916705,
        275.98335299999997,
        276,
        276,
        276,
        276,
        276,
        275.98335299999997,
        276,
        276,
        276,
        276,
        275.933352
      ],
      "usageGrain": "hourly"
    }
  }
}

Codice di stato:: 204

ReservationRecommendationsByBillingProfile-Modern

Esempio di richiesta

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-00000000:00000000-0000-0000-0000-00000000/billingProfiles/00000000-0000-0000-0000-00000000/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope=Shared&region=australiaeast&term=P1Y&lookBackPeriod=Last7Days&product=Standard_B2s&$filter=properties/subscriptionId eq 00000000-0000-0000-0000-00000000

Risposta di esempio

Codice di stato:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-00000000:00000000-0000-0000-0000-00000000/billingProfiles/00000000-0000-0000-0000-00000000/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "AUD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000"
      ],
      "onDemandRate": 0.0725,
      "product": "Standard_B2s",
      "region": "australiaeast",
      "reservationRate": 0.04414166531788041,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": null,
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 632.8844720496894,
          "overageCost": 0,
          "quantity": 1,
          "reservationCost": 387.74038815226174,
          "totalReservationCost": 387.74038815226174,
          "savings": 245.1440838974277
        }
      ],
      "lookBackPeriod": 7,
      "recommendedQuantity": 1,
      "reservationOrderTerm": "P1Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Shared",
    "usage": {
      "firstConsumptionDate": "2020-01-19T00:00:00",
      "lastConsumptionDate": "2020-01-25T17:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        1,
        1,
        1,
        1,
        1,
        1,
        1,
        1,
        1,
        0
      ],
      "usageGrain": "hourly"
    }
  }
}

Codice di stato:: 204

ReservationRecommendationsByResourceGroup-Legacy

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testGroup/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope=Single&region=westus&term=P3Y&lookBackPeriod=Last30Days&product=Standard_DS13_v2

Risposta di esempio

Codice di stato:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testGroup/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "USD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000",
        "testGroup"
      ],
      "onDemandRate": 0.519,
      "product": "Standard_DS13_v2",
      "region": "westus",
      "reservationRate": 0.302549467275493,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": "testGroup",
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 368.4813602070006,
          "overageCost": 0,
          "quantity": 2,
          "reservationCost": 429.01514459665,
          "totalReservationCost": 429.01514459665,
          "savings": -60.5337843896494
        },
        {
          "onDemandCost": 368.481360207,
          "overageCost": 1.557,
          "quantity": 1,
          "reservationCost": 214.507572298325,
          "totalReservationCost": 216.064572298325,
          "savings": 152.416787908675
        }
      ],
      "lookBackPeriod": 30,
      "recommendedQuantity": 1,
      "reservationOrderTerm": "P3Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Single",
    "usage": {
      "firstConsumptionDate": "2020-02-03T00:00:00",
      "lastConsumptionDate": "2020-03-03T13:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        1,
        1,
        1,
        1,
        1,
        1
      ],
      "usageGrain": "hourly"
    }
  }
}

Codice di stato:: 204

ReservationRecommendationsBySubscription-Legacy

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000/providers/Microsoft.Consumption/reservationRecommendationDetails?api-version=2024-08-01&scope=Single&region=westus&term=P3Y&lookBackPeriod=Last30Days&product=Standard_DS13_v2

Risposta di esempio

Codice di stato:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-00000000/providers/microsoft.consumption/reservationrecommendationdetails",
  "name": "reservationRecommendationDetails",
  "type": "Microsoft.Consumption/ReservationRecommendationDetails",
  "properties": {
    "currency": "USD",
    "resource": {
      "appliedScopes": [
        "00000000-0000-0000-0000-00000000"
      ],
      "onDemandRate": 0.519,
      "product": "Standard_DS13_v2",
      "region": "westus",
      "reservationRate": 0.302549467275493,
      "resourceType": "virtualmachines"
    },
    "resourceGroup": null,
    "savings": {
      "calculatedSavings": [
        {
          "onDemandCost": 368.4813602070006,
          "overageCost": 0,
          "quantity": 2,
          "reservationCost": 429.01514459665,
          "totalReservationCost": 429.01514459665,
          "savings": -60.5337843896494
        },
        {
          "onDemandCost": 368.481360207,
          "overageCost": 1.557,
          "quantity": 1,
          "reservationCost": 214.507572298325,
          "totalReservationCost": 216.064572298325,
          "savings": 152.416787908675
        }
      ],
      "lookBackPeriod": 30,
      "recommendedQuantity": 1,
      "reservationOrderTerm": "P3Y",
      "savingsType": "instance",
      "unitOfMeasure": "hour"
    },
    "scope": "Single",
    "usage": {
      "firstConsumptionDate": "2020-02-03T00:00:00",
      "lastConsumptionDate": "2020-03-03T13:00:00",
      "lookBackUnitType": "virtualMachine quantity",
      "usageData": [
        1,
        1,
        1,
        1,
        1,
        1
      ],
      "usageGrain": "hourly"
    }
  }
}

Codice di stato:: 204

Definizioni

Nome	Descrizione
HighCasedErrorDetails	Dettagli dell'errore.
HighCasedErrorResponse	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".
lookBackPeriod	Filtrare il periodo di tempo in base al quale si basano i risultati delle raccomandazioni di prenotazione.
ReservationRecommendationDetailsCalculatedSavingsProperties	Dettagli dei risparmi stimati. I costi e i risparmi sono stimati per il termine.
ReservationRecommendationDetailsModel	Dettagli della raccomandazione per la prenotazione.
ReservationRecommendationDetailsResourceProperties	Dettagli della risorsa.
ReservationRecommendationDetailsSavingsProperties	Dettagli dei risparmi stimati.
ReservationRecommendationDetailsUsageProperties	Informazioni dettagliate sui dati di utilizzo cronologici usati per il calcolo della raccomandazione.
scope	Ambito della prenotazione.
term	Specificare la lunghezza del termine di raccomandazione per la prenotazione.

HighCasedErrorDetails

Object

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.

HighCasedErrorResponse

Object

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	HighCasedErrorDetails	Dettagli dell'errore.

lookBackPeriod

Enumerazione

Filtrare il periodo di tempo in base al quale si basano i risultati delle raccomandazioni di prenotazione.

Valore	Descrizione
Last30Days	Usare 30 giorni di dati per le raccomandazioni
Last60Days	Usare 60 giorni di dati per le raccomandazioni
Last7Days	Usare 7 giorni di dati per le raccomandazioni

ReservationRecommendationDetailsCalculatedSavingsProperties

Object

Dettagli dei risparmi stimati. I costi e i risparmi sono stimati per il termine.

Nome	Tipo	Descrizione
onDemandCost	number	Costo senza prenotazione. Include i costi hardware e software.
overageCost	number	Costo hardware e software delle risorse non coperte dalla prenotazione.
quantity	number	Quantità di risparmi calcolati.
reservationCost	number	Costo hardware delle risorse coperte dalla prenotazione.
reservedUnitCount	number	Numero di unità riservate utilizzate per calcolare i risparmi. Sempre 1 per le macchine virtuali.
savings	number	Importo salvato acquistando la quantità consigliata di prenotazione. Uguale a onDemandCost - totalReservationCost.
totalReservationCost	number	Costo prenotazione + costo software delle risorse coperte dalla prenotazione + costo eccedenza.

ReservationRecommendationDetailsModel

Object

Dettagli della raccomandazione per la prenotazione.

Nome	Tipo	Descrizione
etag	string	Etag per la risorsa.
id	string	ID ARM completo di un evento.
location	string	Percorso risorsa.
name	string	ID che identifica in modo univoco un evento.
properties.currency	string	Identificatore del codice di valuta ISO 4217 per i costi e i risparmi
properties.resource	ReservationRecommendationDetailsResourceProperties	Proprietà specifiche della risorsa.
properties.resourceGroup	string	Gruppo di risorse.
properties.savings	ReservationRecommendationDetailsSavingsProperties	Informazioni sui risparmi per la raccomandazione.
properties.scope	string	Ambito della prenotazione, ad esempio Single o Shared.
properties.usage	ReservationRecommendationDetailsUsageProperties	Dettagli di utilizzo cronologici usati per calcolare i risparmi stimati.
sku	string	SKU risorsa
tags	object	Tag di risorsa.
type	string	Tipo di risorsa.

ReservationRecommendationDetailsResourceProperties

Object

Dettagli della risorsa.

Nome	Tipo	Descrizione
appliedScopes	string[]	Elenco di sottoscrizioni per cui viene applicata la prenotazione.
onDemandRate	number	Frequenza oraria su richiesta della risorsa. Include solo la tariffa hardware, ad esempio, la tariffa software non è inclusa.
product	string	Prodotto Azure, ad esempio: Standard_E8s_v3 e così via.
region	string	Area risorse di Azure, ad esempio EastUS, WestUS e così via.
reservationRate	number	Tariffa oraria della prenotazione della risorsa. Varia in base al termine.
resourceType	string	Tipo di risorsa di Azure.

ReservationRecommendationDetailsSavingsProperties

Object

Dettagli dei risparmi stimati.

Nome	Tipo	Descrizione
calculatedSavings	ReservationRecommendationDetailsCalculatedSavingsProperties[]	Elenco dei risparmi calcolati.
lookBackPeriod	integer (int32)	Numero di giorni di utilizzo da esaminare per il calcolo della raccomandazione.
recommendedQuantity	number	Numero di unità consigliate della risorsa.
reservationOrderTerm	string	Periodo di tempo della prenotazione. ad esempio: P1M, P1Y o P3Y.
savingsType	string	Tipo di risparmio, ad esempio istanza.
unitOfMeasure	string	Unità di misura, ad esempio: ora e così via.

ReservationRecommendationDetailsUsageProperties

Object

Informazioni dettagliate sui dati di utilizzo cronologici usati per il calcolo della raccomandazione.

Nome	Tipo	Descrizione
firstConsumptionDate	string	La prima data di utilizzo usata per cercare di calcolare la raccomandazione.
lastConsumptionDate	string	Data dell'ultimo utilizzo usata per cercare di calcolare la raccomandazione.
lookBackUnitType	string	Quali valori dei dati di utilizzo rappresentano, ad esempio, l'istanza della macchina virtuale.
usageData	number[]	Suddivisione dell'utilizzo cronologico delle risorse. I valori sono nell'ordine di utilizzo tra firstConsumptionDate e lastConsumptionDate.
usageGrain	string	Granularità dei valori rappresentati nei dati di utilizzo, ad esempio: oraria.

scope

Enumerazione

Ambito della prenotazione.

Valore	Descrizione
Shared
Single

term

Enumerazione

Specificare la lunghezza del termine di raccomandazione per la prenotazione.

Valore	Descrizione
P1M	Periodo di prenotazione di 1 mese
P1Y	Periodo di prenotazione di 1 anno
P3Y	Periodo di prenotazione di 3 anni

Condividi tramite

Reservation Recommendation Details - Get

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ReservationRecommendationsByBillingAccount-Legacy

Esempio di richiesta

Risposta di esempio

ReservationRecommendationsByBillingProfile-Modern

Esempio di richiesta

Risposta di esempio

ReservationRecommendationsByResourceGroup-Legacy

Esempio di richiesta

Risposta di esempio

ReservationRecommendationsBySubscription-Legacy

Esempio di richiesta

Risposta di esempio

Definizioni

HighCasedErrorDetails

HighCasedErrorResponse

lookBackPeriod

ReservationRecommendationDetailsCalculatedSavingsProperties

ReservationRecommendationDetailsModel

ReservationRecommendationDetailsResourceProperties

ReservationRecommendationDetailsSavingsProperties

ReservationRecommendationDetailsUsageProperties

scope

term

Risorse aggiuntive