Reservation Transactions - List
Liste der Transaktionen für reservierte Instanzen im Abrechnungskontobereich. Hinweis: Die Erstattungstransaktionen werden zusammen mit ihrer Kauftransaktion (d. h. im Abrechnungsmonat des Kaufs) gebucht. Die Rückerstattung wird beispielsweise im Mai 2021 angefordert. Diese Rückerstattungstransaktion hat das Ereignisdatum als Mai 2021, aber der Abrechnungsmonat als April 2020, als der Reservierungskauf getätigt wurde. Hinweis: ARM hat eine Nutzlastgröße von 12 MB, sodass derzeit Anrufer 400 erhalten, wenn die Antwortgröße den ARM-Grenzwert überschreitet. In solchen Fällen sollte der API-Aufruf mit kleineren Datumsbereichen erfolgen.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?api-version=2024-08-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?$filter={$filter}&api-version=2024-08-01&useMarkupIfPartner={useMarkupIfPartner}&previewMarkupPercentage={previewMarkupPercentage}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
billing
|
path | True |
string |
BillingAccount-ID |
api-version
|
query | True |
string |
Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2023-03-01. |
$filter
|
query |
string |
Filtern sie Reservierungstransaktionen nach Datumsbereich. Die Eigenschaften/EventDate für Startdatum und Enddatum. Der Filter unterstützt "le" und "ge". Hinweis: DIE API gibt Daten für den gesamten Abrechnungs- und Enddatumsmonat des gesamten Startdatums zurück. Beispielsweise enthalten Filtereigenschaften/eventDate+ge+2020-01-01-01+AND+properties/eventDate+le+2020-12-29 Daten für den gesamten Monat Dezember 2020 (d. h. Datensätze für Datumsangaben vom 30. und 31. Dezember) |
|
preview
|
query |
number (decimal) |
Vorschaumarkierungsprozentsatz, der angewendet werden soll. |
|
use
|
query |
boolean |
Wendet mark up to the transactions if the caller is a partner. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OKAY. Die Anforderung ist erfolgreich. |
|
Other Status Codes |
Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
ReservationTransactionsByEnrollmentNumber
Beispielanforderung
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=2024-08-01&useMarkupIfPartner=True&previewMarkupPercentage=15.5
Beispiel für eine Antwort
{
"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
}
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Die Details des Fehlers. |
Error |
Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. Einige Fehlerantworten:
|
Reservation |
Reservierungstransaktionsressource. |
Reservation |
Ergebnis der Auflistung von Reservierungsempfehlungen. |
ErrorDetails
Die Details des Fehlers.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode. |
message |
string |
Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist. |
ErrorResponse
Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
Einige Fehlerantworten:
429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.
503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.
504 Gatewaytimeout – Diensttimeout beim Verarbeiten der Anforderung. Verringern Sie den Datumsbereich in der Anforderung, falls möglich.
Name | Typ | Beschreibung |
---|---|---|
error |
Die Details des Fehlers. |
ReservationTransaction
Reservierungstransaktionsressource.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Ressourcen-ID. |
name |
string |
Ressourcenname. |
properties.accountName |
string |
Der Name des Kontos, das die Transaktion vorgibt. |
properties.accountOwnerEmail |
string |
Die E-Mail des Kontobesitzers, der die Transaktion vorgibt. |
properties.amount |
number (decimal) |
Die Gebühr der Transaktion. |
properties.armSkuName |
string |
Dies ist der ARM-Sku-Name. Sie kann verwendet werden, um mit dem ServiceType-Feld in zusätzlichen Informationen in Verwendungsdatensätzen zu verbinden. |
properties.billingFrequency |
string |
Die Abrechnungshäufigkeit, die entweder einmalig oder periodische Sein kann. |
properties.billingMonth |
integer (int32) |
Der Abrechnungsmonat (yyyyMMdd), für den das Ereignis initiiert wurde. |
properties.costCenter |
string |
Die Kostenstelle dieser Abteilung, wenn es sich um eine Abteilung handelt und eine Kostenstelle bereitgestellt wird. |
properties.currency |
string |
Die ISO-Währung, in der die Transaktion berechnet wird, z. B. USD. |
properties.currentEnrollment |
string |
Die aktuelle Registrierung. |
properties.departmentName |
string |
Der Abteilungsname. |
properties.description |
string |
Die Beschreibung der Transaktion. |
properties.eventDate |
string (date-time) |
Das Datum der Transaktion |
properties.eventType |
string |
Der Typ der Transaktion (Kauf, Stornierung oder Rückerstattung). |
properties.monetaryCommitment |
number (decimal) |
Der Geldzusagebetrag im Registrierungsumfang. |
properties.overage |
number (decimal) |
Der Überschreibungsbetrag im Registrierungsbereich. |
properties.purchasingEnrollment |
string |
Die Einkaufsregistrierung. |
properties.purchasingSubscriptionGuid |
string (uuid) |
Die Abonnement-GUID, die die Transaktion vorgibt. |
properties.purchasingSubscriptionName |
string |
Der Abonnementname, der die Transaktion vorgibt. |
properties.quantity |
number (decimal) |
Die Menge der Transaktion. |
properties.region |
string |
Die Region der Transaktion. |
properties.reservationOrderId |
string |
Die Reservierungsauftrags-ID ist der Bezeichner für einen Reservierungskauf. Jede Reservierungsauftrags-ID stellt eine einzelne Kauftransaktion dar. Eine Reservierungsbestellung enthält Reservierungen. Die Reservierungsreihenfolge gibt die Größe und Region des virtuellen Computers für die Reservierungen an. |
properties.reservationOrderName |
string |
Der Name des Reservierungsauftrags. |
properties.term |
string |
Dies ist der Begriff der Transaktion. |
tags |
string[] |
Ressourcentags. |
type |
string |
Ressourcentyp. |
ReservationTransactionsListResult
Ergebnis der Auflistung von Reservierungsempfehlungen.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Der Link (URL) zur nächsten Seite der Ergebnisse. |
value |
Die Liste der Reservierungsempfehlungen. |