Reservation Transactions - List

Reference

Služba:: Consumption

Verze rozhraní API:: 2024-08-01

Seznam transakcí pro rezervované instance v rámci rozsahu fakturačního účtu. Poznámka: Transakce refundace se publikují spolu s nákupní transakcí (tj. v nákupním fakturačním měsíci). Například refundace se požaduje v květnu 2021. Tato transakce refundace bude mít datum události jako květen 2021, ale fakturační měsíc jako duben 2020 při nákupu rezervace. Poznámka: ARM má limit velikosti datové části 12 MB, takže v současné době volající dostanou 400, když velikost odpovědi překročí limit ARM. V takových případech by se mělo volat rozhraní API s menšími rozsahy kalendářních dat.

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

S volitelnými parametry:

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
billingAccountId	path	True	string	ID fakturačního účtu
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 2023-03-01.
$filter	query		string	Filtrovat transakce rezervací podle rozsahu kalendářních dat Vlastnosti/Datum události pro počáteční a koncové datum. Filtr podporuje "le" a "ge". Poznámka: Rozhraní API vrací data pro celé počáteční a koncové datum fakturačního měsíce. Například filtrování vlastností/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 bude obsahovat data za celý měsíc z prosince 2020 (tj. budou obsahovat záznamy pro data 30. prosince a 31).
previewMarkupPercentage	query		number (decimal)	Zobrazí se procento přirážky náhledu, které se má použít.
useMarkupIfPartner	query		boolean	Použije označení transakcí, pokud je volající partnerem.

Odpovědi

Name	Typ	Description
200 OK	ReservationTransactionsListResult	OK. Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ReservationTransactionsByEnrollmentNumber

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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
      }
    }
  ]
}

Definice

Name	Description
ErrorDetails	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě. Některé chybové odpovědi: 429 TooManyRequests – Požadavek je omezený. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění. 504 Vypršení časového limitu brány – Při zpracování požadavku vypršel časový limit služby. Pokud je to možné, snižte rozsah dat v požadavku.
ReservationTransaction	Prostředek transakce rezervace.
ReservationTransactionsListResult	Výsledek výpisu doporučení pro rezervace

ErrorDetails

Objekt

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ErrorResponse

Objekt

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Některé chybové odpovědi:

429 TooManyRequests – Požadavek je omezený. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.
504 Vypršení časového limitu brány – Při zpracování požadavku vypršel časový limit služby. Pokud je to možné, snižte rozsah dat v požadavku.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě.