Reservation Transactions - List
Elenco di transazioni per le istanze riservate nell'ambito dell'account di fatturazione. Nota: le transazioni di rimborso vengono registrate insieme alla relativa transazione di acquisto (ad esempio nel mese di fatturazione dell'acquisto). Ad esempio, il rimborso viene richiesto nel maggio 2021. Questa transazione di rimborso avrà data evento come maggio 2021, ma il mese di fatturazione di aprile 2020 quando è stato effettuato l'acquisto della prenotazione. 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. In questi casi, la chiamata API deve essere eseguita con intervalli di date più piccoli.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?api-version=2023-05-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?$filter={$filter}&api-version=2023-05-01&useMarkupIfPartner={useMarkupIfPartner}&previewMarkupPercentage={previewMarkupPercentage}
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
billing
|
path | True |
string |
BillingAccount ID |
api-version
|
query | True |
string |
Versione dell'API da usare con la richiesta client. La versione corrente è 2023-03-01. |
$filter
|
query |
string |
Filtrare le transazioni di prenotazione in base all'intervallo di date. Proprietà/EventDate per la data di inizio e la data di fine. Il filtro supporta 'le' e 'ge'. Nota: l'API restituisce i dati per l'intero mese di fatturazione della data di inizio e della data di fine. Ad esempio, filtrare le proprietà/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 includerà i dati per l'intero mese di dicembre 2020 (ovvero conterrà record per le date del 30 e 31 dicembre) |
|
preview
|
query |
number decimal |
Percentuale di markup di anteprima da applicare. |
|
use
|
query |
boolean |
Applica contrassegna le transazioni se il chiamante è un partner. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
OK. La richiesta ha avuto esito positivo. |
|
Other Status Codes |
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
ReservationTransactionsByEnrollmentNumber
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/reservationTransactions?$filter=properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30&api-version=2023-05-01&useMarkupIfPartner=True&previewMarkupPercentage=15.5
Sample Response
{
"value": [
{
"id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919",
"name": "201909091919",
"type": "Microsoft.Consumption/reservationTransactions",
"tags": [],
"properties": {
"eventDate": "2019-09-09T19:19:04Z",
"reservationOrderId": "00000000-0000-0000-0000-000000000000",
"description": "Standard_DS1_v2 westus 1 Year",
"eventType": "Refund",
"quantity": 1,
"amount": -21,
"currency": "USD",
"reservationOrderName": "Transaction-DS1_v2",
"purchasingEnrollment": "123456",
"armSkuName": "Standard_DS1_v2",
"term": "P1Y",
"region": "westus",
"purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2",
"purchasingSubscriptionName": "Infrastructure Subscription",
"accountName": "Microsoft Infrastructure",
"accountOwnerEmail": "admin@microsoft.com",
"departmentName": "Unassigned",
"costCenter": "",
"currentEnrollment": "123456",
"billingFrequency": "recurring",
"billingMonth": 20190901,
"monetaryCommitment": 523123.9,
"overage": 23234.49
}
},
{
"id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919",
"name": "201909091919",
"type": "Microsoft.Consumption/reservationTransactions",
"tags": [],
"properties": {
"eventDate": "2019-09-09T19:19:04Z",
"reservationOrderId": "00000000-0000-0000-0000-000000000000",
"description": "Standard_DS1_v2 westus 1 Year",
"eventType": "Purchase",
"quantity": 1,
"amount": 21,
"currency": "USD",
"reservationOrderName": "Transaction-DS1_v2",
"purchasingEnrollment": "123456",
"armSkuName": "Standard_DS1_v2",
"term": "P1Y",
"region": "westus",
"purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2",
"purchasingSubscriptionName": "Infrastructure Subscription",
"accountName": "Microsoft Infrastructure",
"accountOwnerEmail": "admin@microsoft.com",
"departmentName": "Unassigned",
"costCenter": "",
"currentEnrollment": "123456",
"billingFrequency": "recurring",
"billingMonth": 20190901,
"monetaryCommitment": 523123.9,
"overage": 23234.49
}
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Dettagli dell'errore. |
Error |
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:
|
Reservation |
Risorsa transazione di prenotazione. |
Reservation |
Risultato dell'inserimento di raccomandazioni per la 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 |
Dettagli dell'errore. |
ReservationTransaction
Risorsa transazione di prenotazione.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID risorsa. |
name |
string |
Nome risorsa. |
properties.accountName |
string |
Nome dell'account che effettua la transazione. |
properties.accountOwnerEmail |
string |
Indirizzo di posta elettronica del proprietario dell'account che effettua la transazione. |
properties.amount |
number |
Addebito della transazione. |
properties.armSkuName |
string |
Si tratta del nome dello SKU arm. Può essere usato per partecipare al campo serviceType in informazioni aggiuntive nei record di utilizzo. |
properties.billingFrequency |
string |
Frequenza di fatturazione, che può essere una tantum o ricorrente. |
properties.billingMonth |
integer |
Mese di fatturazione (aaMMMdd), in cui l'evento è stato avviato. |
properties.costCenter |
string |
Il centro di costo di questo reparto, se si tratta di un reparto e viene fornito un centro di costo. |
properties.currency |
string |
Valuta ISO in cui viene addebitata la transazione, ad esempio USD. |
properties.currentEnrollment |
string |
Registrazione corrente. |
properties.departmentName |
string |
Nome del reparto. |
properties.description |
string |
Descrizione della transazione. |
properties.eventDate |
string |
Data della transazione |
properties.eventType |
string |
Tipo di transazione (acquisto, annullamento o rimborso). |
properties.monetaryCommitment |
number |
Importo dell'impegno monetario nell'ambito della registrazione. |
properties.overage |
number |
Quantità di eccedenza nell'ambito della registrazione. |
properties.purchasingEnrollment |
string |
Registrazione di acquisto. |
properties.purchasingSubscriptionGuid |
string |
GUID della sottoscrizione che effettua la transazione. |
properties.purchasingSubscriptionName |
string |
Nome della sottoscrizione che effettua la transazione. |
properties.quantity |
number |
Quantità della transazione. |
properties.region |
string |
Area della transazione. |
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.reservationOrderName |
string |
Nome dell'ordine di prenotazione. |
properties.term |
string |
Questo è il termine della transazione. |
tags |
string[] |
Tag delle risorse. |
type |
string |
Tipo di risorsa. |
ReservationTransactionsListResult
Risultato dell'inserimento di raccomandazioni per la prenotazione.
Nome | Tipo | Descrizione |
---|---|---|
nextLink |
string |
Collegamento (URL) alla pagina successiva dei risultati. |
value |
Elenco di raccomandazioni per la prenotazione. |