Reservations Details - List

Riferimento

Service:: Consumption

API Version:: 2023-05-01

Elenchi i dettagli delle prenotazioni per l'intervallo di date specificato. Nota: ARM ha un limite di dimensioni del payload di 12 MB, quindi i chiamanti ricevono attualmente 400 quando le dimensioni della risposta superano il limite arm. Se le dimensioni dei dati sono troppo grandi, i clienti possono ottenere anche 504 quando l'API ha timeout la preparazione dei dati. In questi casi, la chiamata API deve essere eseguita con intervalli di date più piccoli o deve essere effettuata una chiamata all'API Genera report dettagli prenotazione perché è asincrona e non si verifica un timeout delle dimensioni della risposta.

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?api-version=2023-05-01

With optional parameters:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationDetails?startDate={startDate}&endDate={endDate}&$filter={$filter}&reservationId={reservationId}&reservationOrderId={reservationOrderId}&api-version=2023-05-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceScope	path	True	string	Ambito associato alle operazioni dettagliate delle prenotazioni. Sono inclusi "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" per l'ambito BillingAccount (legacy) e "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" per l'ambito BillingProfile (moderno).
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione corrente è 2023-03-01.
$filter	query		string	Filtrare i dettagli della prenotazione in base all'intervallo di date. Proprietà/UsageDate per la data di inizio e la data di fine. Il filtro supporta 'le' e 'ge'. Non applicabile durante l'esecuzione di query con il profilo di fatturazione
endDate	query		string	Data di fine. Applicabile solo quando si eseguono query con il profilo di fatturazione
reservationId	query		string	GUID ID prenotazione. Valido solo se viene fornito anche reservationOrderId. Filtrare in base a una prenotazione specifica
reservationOrderId	query		string	GUID ID ordine prenotazione. Obbligatorio se viene specificato reservationId. Filtrare in base a un ordine di prenotazione specifico
startDate	query		string	Data di inizio. Applicabile solo quando si eseguono query con il profilo di fatturazione

Risposte

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ReservationDetailsByBillingAccountId

ReservationDetailsByBillingProfileId

ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails?$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-12-05&api-version=2023-05-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "usageDate": "2017-11-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

ReservationDetailsByBillingProfileId

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?startDate=2019-09-01&endDate=2019-10-31&api-version=2023-05-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "usageDate": "2019-09-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

ReservationDetailsByBillingProfileIdReservationId

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?startDate=2019-09-01&endDate=2019-10-31&reservationId=1c6b6358-709f-484c-85f1-72e862a0cf3b&reservationOrderId=9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc&api-version=2023-05-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc",
        "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
        "usageDate": "2019-09-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
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 l'attesa del tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".
ReservationDetail	risorsa dettagli prenotazione.
ReservationDetailsListResult	Risultato della presentazione dei dettagli della prenotazione.

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 l'attesa del tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore.

ReservationDetail

risorsa dettagli 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.instanceFlexibilityGroup	string	Gruppo di flessibilità dell'istanza.
properties.instanceFlexibilityRatio	string	Rapporto di flessibilità dell'istanza.
properties.instanceId	string	Questo identificatore indica il nome della risorsa o l'ID risorsa completo.
properties.kind	string	Tipo di prenotazione.
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	Si tratta delle ore totali riservate per il giorno. 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	Si tratta del nome dello SKU arm. Può essere usato per partecipare al campo serviceType in informazioni aggiuntive nei record di utilizzo.
properties.totalReservedQuantity	number	Questo è il numero totale di istanze riservate per reservationId.
properties.usageDate	string	Data in cui si è verificato l'utilizzo.
properties.usedHours	number	Si tratta delle ore totali usate dall'istanza di .
tags	object	Tag delle risorse.
type	string	Tipo di risorsa.

ReservationDetailsListResult

Risultato della presentazione dei dettagli della prenotazione.

Nome	Tipo	Descrizione
nextLink	string	Collegamento (URL) alla pagina successiva dei risultati.
value	ReservationDetail[]	Elenco dei dettagli della prenotazione.

Reservations Details - List

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Scopes

Esempio

ReservationDetailsByBillingAccountId

Sample Request

Sample Response

ReservationDetailsByBillingProfileId

Sample Request

Sample Response

ReservationDetailsByBillingProfileIdReservationId

Sample Request

Sample Response

Definizioni

ErrorDetails

ErrorResponse

ReservationDetail

ReservationDetailsListResult

Risorse aggiuntive