Reservations Summaries - List By Reservation Order And Reservation

Riferimento

Servizio:: Consumption

Versione API:: 2024-08-01

Elenca i riepiloghi delle prenotazioni per la granularità giornaliera o mensile. Nota: ARM ha un limite di dimensioni del payload di 12 MB, quindi i chiamanti ottengono attualmente 400 quando le dimensioni della risposta superano il limite arm. In questi casi, la chiamata API deve essere eseguita con intervalli di date più piccoli.

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&api-version=2024-08-01

Con parametri facoltativi:

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&$filter={$filter}&api-version=2024-08-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
reservationId	path	True	string	ID della prenotazione
reservationOrderId	path	True	string	ID ordine della prenotazione
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione corrente è 2023-03-01.
grain	query	True	datagrain	Può essere giornaliera o mensile
$filter	query		string	Obbligatorio solo per il grano giornaliero. Proprietà/UsageDate per data di inizio e data di fine. Il filtro supporta 'le' e 'ge'

Risposte

Nome	Tipo	Descrizione
200 OK	ReservationSummariesListResult	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

ReservationSummariesDailyWithReservationId

ReservationSummariesMonthlyWithReservationId

ReservationSummariesDailyWithReservationId

Esempio di richiesta

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=daily&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20&api-version=2024-08-01

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_D8s_v3",
        "kind": "Reservation",
        "reservedHours": 0,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "totalReservedQuantity": 155,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithReservationId

Esempio di richiesta

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&api-version=2024-08-01

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_D8s_v3",
        "kind": "Reservation",
        "reservedHours": 0,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "totalReservedQuantity": 155,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      }
    }
  ]
}

Definizioni

Nome	Descrizione
datagrain	Può essere giornaliera o mensile
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". Timeout del gateway 504 - Timeout del servizio durante l'elaborazione della richiesta. Ridurre l'intervallo di date nella richiesta, se possibile.
ReservationSummariesListResult	Risultato dell'elenco dei riepiloghi delle prenotazioni.
ReservationSummary	risorsa di riepilogo della prenotazione.

datagrain

Enumerazione

Può essere giornaliera o mensile

Valore	Descrizione
daily	Granularità giornaliera dei dati
monthly	Granularità mensile dei dati

ErrorDetails

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.

ErrorResponse

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".
Timeout del gateway 504 - Timeout del servizio durante l'elaborazione della richiesta. Ridurre l'intervallo di date nella richiesta, se possibile.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore.

ReservationSummariesListResult

Object

Risultato dell'elenco dei riepiloghi delle prenotazioni.

Nome	Tipo	Descrizione
nextLink	string	Collegamento (URL) alla pagina successiva dei risultati.
value	ReservationSummary[]	Elenco di riepiloghi delle prenotazioni.

ReservationSummary

Object

risorsa di riepilogo della prenotazione.

Nome	Tipo	Descrizione
etag	string	Etag per la risorsa.
id	string	ID ARM completo di un evento.
name	string	ID che identifica in modo univoco un evento.
properties.avgUtilizationPercentage	number (decimal)	Si tratta dell'utilizzo medio per l'intero intervallo di tempo. (giorno o mese a seconda del grano)
properties.kind	string	Tipo di prenotazione.
properties.maxUtilizationPercentage	number (decimal)	Questo è l'utilizzo massimo orario nell'ora di utilizzo (giorno o mese). Ad esempio, se il record di utilizzo corrisponde al 12/10/2017 e su tale record per l'ora 4 e 5, l'utilizzo è stato di 100%, questo campo restituirà 100% per quel giorno.
properties.minUtilizationPercentage	number (decimal)	Si tratta dell'utilizzo orario minimo nell'ora di utilizzo (giorno o mese). Ad esempio, se il record di utilizzo corrisponde al 12/10/2017 e su tale record per l'ora 4 e 5, l'utilizzo è stato 10%, questo campo restituirà 10% per quel giorno
properties.purchasedQuantity	number (decimal)	Si tratta della quantità acquistata per reservationId.
properties.remainingQuantity	number (decimal)	Si tratta della quantità rimanente per reservationId.
properties.reservationId	string	L'ID prenotazione è l'identificatore di una prenotazione all'interno di un ordine di prenotazione. Ogni prenotazione è il raggruppamento per l'applicazione dell'ambito del vantaggio e specifica anche il numero di istanze a cui è possibile applicare il vantaggio di prenotazione.
properties.reservationOrderId	string	L'ID dell'ordine di prenotazione è l'identificatore per un acquisto di prenotazione. Ogni ID ordine di prenotazione rappresenta una singola transazione di acquisto. Un ordine di prenotazione contiene prenotazioni. L'ordine di prenotazione specifica le dimensioni e l'area della macchina virtuale per le prenotazioni.
properties.reservedHours	number (decimal)	Si tratta delle ore totali riservate. Ad esempio, se la prenotazione per 1 istanza è stata effettuata alle 13,00, saranno 11 ore per quel giorno e 24 ore dai giorni successivi
properties.skuName	string	Questo è il nome dello SKU arm. Può essere usato per creare un join con il campo serviceType in informazioni aggiuntive nei record di utilizzo.
properties.totalReservedQuantity	number (decimal)	Questo è il numero totale di istanze riservate per reservationId.
properties.usageDate	string (date-time)	Dati corrispondenti al record di utilizzo. Se la granularità dei dati è mensile, sarà il primo giorno del mese.
properties.usedHours	number (decimal)	Totale ore usate dalla prenotazione
properties.usedQuantity	number (decimal)	Si tratta della quantità usata per reservationId.
properties.utilizedPercentage	number (decimal)	Questa è la percentuale utilizzata per l'ID prenotazione.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa.

Condividi tramite

Reservations Summaries - List By Reservation Order And Reservation

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ReservationSummariesDailyWithReservationId

Esempio di richiesta

Risposta di esempio

ReservationSummariesMonthlyWithReservationId

Esempio di richiesta

Risposta di esempio

Definizioni

datagrain

ErrorDetails

ErrorResponse

ReservationSummariesListResult

ReservationSummary

Risorse aggiuntive