Reservation Transactions - List

Referensi

Service:: Consumption

API Version:: 2023-05-01

Daftar transaksi untuk instans yang dipesan pada cakupan akun penagihan. Catatan: Transaksi pengembalian dana diposting bersama dengan transaksi pembeliannya (yaitu pada bulan penagihan pembelian). Misalnya, pengembalian dana diminta pada Mei 2021. Transaksi pengembalian dana ini akan memiliki tanggal peristiwa pada Mei 2021 tetapi bulan penagihan sebagai April 2020 ketika pembelian reservasi dilakukan. Catatan: ARM memiliki batas ukuran payload 12MB, sehingga saat ini pemanggil mendapatkan 400 ketika ukuran respons melebihi batas ARM. Dalam kasus seperti itu, panggilan API harus dilakukan dengan rentang tanggal yang lebih kecil.

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}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
billingAccountId	path	True	string	BillingAccount ID
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2023-03-01.
$filter	query		string	Memfilter transaksi reservasi menurut rentang tanggal. Properti/EventDate untuk tanggal mulai dan tanggal selesai. Filter mendukung 'le' dan 'ge'. Catatan: API mengembalikan data untuk seluruh tanggal mulai dan bulan penagihan tanggal selesai. Misalnya, properti filter/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 akan menyertakan data untuk seluruh bulan Desember 2020 (yaitu akan berisi rekaman untuk tanggal 30 dan 31 Desember)
previewMarkupPercentage	query		number decimal	Pratinjau persentase markup yang akan diterapkan.
useMarkupIfPartner	query		boolean	Menerapkan mark up ke transaksi jika penelepon adalah mitra.

Respons

Nama	Jenis	Deskripsi
200 OK	ReservationTransactionsListResult	OK. Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
ErrorDetails	Detail kesalahan.
ErrorResponse	Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan. Beberapa respons Kesalahan: 429 TooManyRequests - Permintaan dibatasi. Coba lagi setelah menunggu waktu yang ditentukan di header "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable - Layanan untuk sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".
ReservationTransaction	Sumber daya transaksi reservasi.
ReservationTransactionsListResult	Hasil daftar rekomendasi reservasi.

ErrorDetails

Detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

ErrorResponse

Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Beberapa respons Kesalahan:

429 TooManyRequests - Permintaan dibatasi. Coba lagi setelah menunggu waktu yang ditentukan di header "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable - Layanan untuk sementara tidak tersedia. Coba lagi setelah menunggu selama waktu yang ditentukan di header "Coba Lagi Setelah".

Nama	Jenis	Deskripsi
error	ErrorDetails	Detail kesalahan.