Reservation Transactions - List

Referenz

Service:: Consumption

API Version:: 2023-05-01

Liste der Transaktionen für reservierte Instanzen im Abrechnungskontobereich. Hinweis: Die Erstattungstransaktionen werden zusammen mit der Kauftransaktion (d. h. im Monat der Kaufabrechnung) gebucht. Beispielsweise wird die Rückerstattung im Mai 2021 angefordert. Diese Rückerstattungstransaktion hat das Ereignisdatum Mai 2021, aber den Abrechnungsmonat April 2020, in dem der Reservierungskauf getätigt wurde. Hinweis: Arm hat eine Nutzlastgröße von 12 MB, sodass Aufrufer derzeit 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=2023-05-01

With optional parameters:

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}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
billingAccountId	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 von Reservierungstransaktionen nach Datumsbereich. Die Eigenschaften/EventDate für Start- und Enddatum. Der Filter unterstützt "le" und "ge". Hinweis: Die API gibt Daten für den gesamten Abrechnungsmonat des Start- und Enddatums zurück. Beispielsweise enthält filter properties/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 Daten für den gesamten Monat Dezember 2020 (d. h. enthält Datensätze für Datumsangaben vom 30. und 31. Dezember).
previewMarkupPercentage	query		number decimal	Vorschau-Markupprozentsatz, der angewendet werden soll.
useMarkupIfPartner	query		boolean	Wendet mark up auf die Transaktionen an, wenn der Aufrufer ein Partner ist.

Antworten

Name	Typ	Beschreibung
200 OK	ReservationTransactionsListResult	OK. Die Anforderung war erfolgreich.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ReservationTransactionsByEnrollmentNumber

Sample Request

HTTP

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

Status code:: 200

{
  "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
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. Einige Fehlerantworten: 429 TooManyRequests: Die Anforderung wird gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit gewartet haben. 503 ServiceUnavailable: Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.
ReservationTransaction	Reservierungstransaktionsressource.
ReservationTransactionsListResult	Ergebnis der Auflistung von Reservierungsempfehlungen.

ErrorDetails

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Die Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

429 TooManyRequests: Die Anforderung wird gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit gewartet haben.
503 ServiceUnavailable: Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.