Reservation Transactions - List

Referens

Tjänst:: Consumption

API-version:: 2024-08-01

Lista över transaktioner för reserverade instanser inom faktureringskontots omfång. Obs! Återbetalningstransaktionerna bokförs tillsammans med inköpstransaktionen (dvs. under faktureringsmånaden för köpet). Återbetalningen begärs till exempel i maj 2021. Den här återbetalningstransaktionen har händelsedatum som maj 2021 men faktureringsmånaden som april 2020 när reservationsköpet gjordes. Obs! ARM har en storleksgräns på 12 MB, så för närvarande får anropare 400 när svarsstorleken överskrider ARM-gränsen. I sådana fall bör API-anrop göras med mindre datumintervall.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?api-version=2024-08-01

Med valfria parametrar:

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-parametrar

Name	I	Obligatorisk	Typ	Description
billingAccountId	path	True	string	FaktureringKonto-ID
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2023-03-01.
$filter	query		string	Filtrera reservationstransaktioner efter datumintervall. Egenskaper/EventDate för startdatum och slutdatum. Filtret stöder "le" och "ge". Obs! API returnerar data för hela startdatumets och slutdatumets faktureringsmånad. Till exempel kommer filteregenskaper/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 att innehålla data för hela december 2020-månaden (dvs. innehåller poster för datum 30 och 31 december)
previewMarkupPercentage	query		number (decimal)	Förhandsgranskningsmarkeringsprocent som ska tillämpas.
useMarkupIfPartner	query		boolean	Tillämpar markeringen på transaktionerna om anroparen är en partner.

Svar

Name	Typ	Description
200 OK	ReservationTransactionsListResult	OKEJ. Begäran har slutförts.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ReservationTransactionsByEnrollmentNumber

Exempelbegäran

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=2024-08-01&useMarkupIfPartner=True&previewMarkupPercentage=15.5

Exempelsvar

Statuskod:: 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
      }
    }
  ]
}

Definitioner

Name	Description
ErrorDetails	Information om felet.
ErrorResponse	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet. Några felsvar: 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen". 504 Gateway Timeout – Tidsgränsen för tjänsten uppnåddes när begäran bearbetades. Minska datumintervallet i begäran, om möjligt.
ReservationTransaction	Reservationstransaktionsresurs.
ReservationTransactionsListResult	Resultat av att lista reservationsrekommendationer.

ErrorDetails

Objekt

Information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Objekt

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".
504 Gateway Timeout – Tidsgränsen för tjänsten uppnåddes när begäran bearbetades. Minska datumintervallet i begäran, om möjligt.

Name	Typ	Description
error	ErrorDetails	Information om felet.