Reservation Transactions - List

Referensi

Service:: Consumption

API Version:: 2021-10-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.

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

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?$filter={$filter}&api-version=2021-10-01

Parameter URI

Name	In	Required	Type	Description
billingAccountId	path	True	string	BillingAccount ID
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2021-10-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)

Respons

Name	Type	Description
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

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

ReservationTransactionsByEnrollmentNumber

Sample Request

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=2021-10-01

import com.azure.core.util.Context;

/** Samples for ReservationTransactions List. */
public final class Main {
    /*
     * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/ReservationTransactionsListByEnrollmentNumber.json
     */
    /**
     * Sample code: ReservationTransactionsByEnrollmentNumber.
     *
     * @param manager Entry point to ConsumptionManager.
     */
    public static void reservationTransactionsByEnrollmentNumber(
        com.azure.resourcemanager.consumption.ConsumptionManager manager) {
        manager
            .reservationTransactions()
            .list("123456", "properties/eventDate ge 2020-05-20 AND properties/eventDate le 2020-05-30", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armconsumption_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/ReservationTransactionsListByEnrollmentNumber.json
func ExampleReservationTransactionsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armconsumption.NewReservationTransactionsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("123456",
		&armconsumption.ReservationTransactionsClientListOptions{Filter: to.Ptr("properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30")})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

const { ConsumptionManagementClient } = require("@azure/arm-consumption");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List of transactions for reserved instances on billing account scope
 *
 * @summary List of transactions for reserved instances on billing account scope
 * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/ReservationTransactionsListByEnrollmentNumber.json
 */
async function reservationTransactionsByEnrollmentNumber() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const filter = "properties/eventDate ge 2020-05-20 AND properties/eventDate le 2020-05-30";
  const billingAccountId = "123456";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new ConsumptionManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.reservationTransactions.list(billingAccountId, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

reservationTransactionsByEnrollmentNumber().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

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.

Name	Type	Description
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".

Name	Type	Description
error	ErrorDetails	Detail kesalahan.

ReservationTransaction

Sumber daya transaksi reservasi.

Name	Type	Description
id	string	Id Sumber Daya.
name	string	Nama sumber daya.
properties.accountName	string	Nama akun yang melakukan transaksi.
properties.accountOwnerEmail	string	Email pemilik akun yang melakukan transaksi.
properties.amount	number	Biaya transaksi.
properties.armSkuName	string	Ini adalah nama ARM Sku. Ini dapat digunakan untuk bergabung dengan bidang serviceType dalam info tambahan dalam rekaman penggunaan.
properties.billingFrequency	string	Frekuensi penagihan, yang dapat berupa satu kali atau berulang.
properties.billingMonth	integer	Bulan penagihan (yyyyMMdd), tempat acara dimulai.
properties.costCenter	string	Pusat biaya departemen ini jika merupakan departemen dan pusat biaya disediakan.
properties.currency	string	Mata uang ISO tempat transaksi ditagih, misalnya, USD.
properties.currentEnrollment	string	Pendaftaran saat ini.
properties.departmentName	string	Nama departemen.
properties.description	string	Deskripsi transaksi.
properties.eventDate	string	Tanggal transaksi
properties.eventType	string	Jenis transaksi (Pembelian, Pembatalan, atau Pengembalian Dana).
properties.monetaryCommitment	number	Jumlah komitmen moneter pada cakupan pendaftaran.
properties.overage	number	Jumlah kelebihan penggunaan pada cakupan pendaftaran.
properties.purchasingEnrollment	string	Pendaftaran pembelian.
properties.purchasingSubscriptionGuid	string	Panduan langganan yang melakukan transaksi.
properties.purchasingSubscriptionName	string	Nama langganan yang membuat transaksi.
properties.quantity	number	Kuantitas transaksi.
properties.region	string	Wilayah transaksi.
properties.reservationOrderId	string	ID pesanan reservasi adalah pengidentifikasi untuk pembelian reservasi. Setiap ID pesanan reservasi mewakili satu transaksi pembelian. Pesanan reservasi berisi reservasi. Pesanan reservasi menentukan ukuran dan wilayah VM untuk reservasi.
properties.reservationOrderName	string	Nama pesanan reservasi.
properties.term	string	Ini adalah jangka waktu transaksi.
tags	string[]	Tag sumber daya.
type	string	Jenis sumber daya

ReservationTransactionsListResult

Hasil daftar rekomendasi reservasi.

Name	Type	Description
nextLink	string	Tautan (url) ke halaman hasil berikutnya.
value	ReservationTransaction[]	Daftar rekomendasi reservasi.