Reservation Transactions - List

Szolgáltatás:

Consumption

API-verzió:

2024-08-01

Fenntartott példányok tranzakcióinak listája a számlázási fiók hatókörében. Megjegyzés: A visszatérítési tranzakciók a vásárlási tranzakcióval együtt (azaz a vásárlás számlázási hónapjában) lesznek közzétéve. A visszatérítést például 2021 májusában kérik. Ennek a visszatérítési tranzakciónak 2021 májusában lesz eseménydátuma, de a számlázási hónap 2020 áprilisában lesz, amikor a foglalás vásárlása megtörtént. Megjegyzés: Az ARM hasznos adatméretének korlátja 12 MB, ezért a hívók jelenleg 400-ot kapnak, ha a válasz mérete meghaladja az ARM-korlátot. Ilyen esetekben az API-hívásokat kisebb dátumtartományokkal kell kezdeményezni.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
billingAccountId	path	True	string	BillingAccount azonosítója
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.
$filter	query		string	Foglalási tranzakciók szűrése dátumtartomány szerint. A kezdési dátum és a záró dátum tulajdonságai/EventDate. A szűrő támogatja a "le" és a "ge" elemet. Megjegyzés: Az API a teljes kezdő és záró dátum számlázási hónapjának adatait adja vissza. A szűrőtulajdonságok/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 például a teljes 2020. decemberi hónap adatait tartalmazzák (azaz a december 30-i és a 31-i dátumok rekordjait tartalmazzák)
previewMarkupPercentage	query		number (decimal)	Az előnézeti korrektúra százalékos alkalmazása.
useMarkupIfPartner	query		boolean	Megjelöli a tranzakciókat, ha a hívó partner.

Válaszok

Name	Típus	Description
200 OK	ReservationTransactionsListResult	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ReservationTransactionsByEnrollmentNumber

Mintakérelem

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/reservationTransactions?api-version=2024-08-01&$filter=properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30&useMarkupIfPartner=True&previewMarkupPercentage=15.5

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.consumption import ConsumptionManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-consumption
# USAGE
    python reservation_transactions_list_by_enrollment_number.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ConsumptionManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.reservation_transactions.list(
        billing_account_id="123456",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2024-08-01/ReservationTransactionsListByEnrollmentNumber.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

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/v2"
)

// Generated from example definition: 2024-08-01/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()
	clientFactory, err := armconsumption.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReservationTransactionsClient().NewListPager("123456", &armconsumption.ReservationTransactionsClientListOptions{
		Filter:                  to.Ptr("properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30"),
		PreviewMarkupPercentage: to.Ptr[float64](15.5),
		UseMarkupIfPartner:      to.Ptr(true)})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armconsumption.ReservationTransactionsClientListResponse{
		// 	ReservationTransactionsListResult: armconsumption.ReservationTransactionsListResult{
		// 		Value: []*armconsumption.ReservationTransaction{
		// 			{
		// 				Name: to.Ptr("201909091919"),
		// 				Type: to.Ptr("Microsoft.Consumption/reservationTransactions"),
		// 				ID: to.Ptr("/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919"),
		// 				Properties: &armconsumption.LegacyReservationTransactionProperties{
		// 					Description: to.Ptr("Standard_DS1_v2 westus 1 Year"),
		// 					AccountName: to.Ptr("Microsoft Infrastructure"),
		// 					AccountOwnerEmail: to.Ptr("admin@microsoft.com"),
		// 					Amount: to.Ptr[float64](-21),
		// 					ArmSKUName: to.Ptr("Standard_DS1_v2"),
		// 					BillingFrequency: to.Ptr("recurring"),
		// 					BillingMonth: to.Ptr[int32](20190901),
		// 					CostCenter: to.Ptr(""),
		// 					Currency: to.Ptr("USD"),
		// 					CurrentEnrollment: to.Ptr("123456"),
		// 					DepartmentName: to.Ptr("Unassigned"),
		// 					EventDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-09-09T19:19:04Z"); return t}()),
		// 					EventType: to.Ptr("Refund"),
		// 					MonetaryCommitment: to.Ptr[float64](523123.9),
		// 					Overage: to.Ptr[float64](23234.49),
		// 					PurchasingEnrollment: to.Ptr("123456"),
		// 					PurchasingSubscriptionGUID: to.Ptr("a838a8c3-a408-49e1-ac90-42cb95bff9b2"),
		// 					PurchasingSubscriptionName: to.Ptr("Infrastructure Subscription"),
		// 					Quantity: to.Ptr[float64](1),
		// 					Region: to.Ptr("westus"),
		// 					ReservationOrderID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					ReservationOrderName: to.Ptr("Transaction-DS1_v2"),
		// 					Term: to.Ptr("P1Y"),
		// 				},
		// 				Tags: []*string{
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("201909091919"),
		// 				Type: to.Ptr("Microsoft.Consumption/reservationTransactions"),
		// 				ID: to.Ptr("/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919"),
		// 				Properties: &armconsumption.LegacyReservationTransactionProperties{
		// 					Description: to.Ptr("Standard_DS1_v2 westus 1 Year"),
		// 					AccountName: to.Ptr("Microsoft Infrastructure"),
		// 					AccountOwnerEmail: to.Ptr("admin@microsoft.com"),
		// 					Amount: to.Ptr[float64](21),
		// 					ArmSKUName: to.Ptr("Standard_DS1_v2"),
		// 					BillingFrequency: to.Ptr("recurring"),
		// 					BillingMonth: to.Ptr[int32](20190901),
		// 					CostCenter: to.Ptr(""),
		// 					Currency: to.Ptr("USD"),
		// 					CurrentEnrollment: to.Ptr("123456"),
		// 					DepartmentName: to.Ptr("Unassigned"),
		// 					EventDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-09-09T19:19:04Z"); return t}()),
		// 					EventType: to.Ptr("Purchase"),
		// 					MonetaryCommitment: to.Ptr[float64](523123.9),
		// 					Overage: to.Ptr[float64](23234.49),
		// 					PurchasingEnrollment: to.Ptr("123456"),
		// 					PurchasingSubscriptionGUID: to.Ptr("a838a8c3-a408-49e1-ac90-42cb95bff9b2"),
		// 					PurchasingSubscriptionName: to.Ptr("Infrastructure Subscription"),
		// 					Quantity: to.Ptr[float64](1),
		// 					Region: to.Ptr("westus"),
		// 					ReservationOrderID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					ReservationOrderName: to.Ptr("Transaction-DS1_v2"),
		// 					Term: to.Ptr("P1Y"),
		// 				},
		// 				Tags: []*string{
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "name": "201909091919",
      "type": "Microsoft.Consumption/reservationTransactions",
      "id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919",
      "properties": {
        "description": "Standard_DS1_v2 westus 1 Year",
        "accountName": "Microsoft Infrastructure",
        "accountOwnerEmail": "admin@microsoft.com",
        "amount": -21,
        "armSkuName": "Standard_DS1_v2",
        "billingFrequency": "recurring",
        "billingMonth": 20190901,
        "costCenter": "",
        "currency": "USD",
        "currentEnrollment": "123456",
        "departmentName": "Unassigned",
        "eventDate": "2019-09-09T19:19:04Z",
        "eventType": "Refund",
        "monetaryCommitment": 523123.9,
        "overage": 23234.49,
        "purchasingEnrollment": "123456",
        "purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2",
        "purchasingSubscriptionName": "Infrastructure Subscription",
        "quantity": 1,
        "region": "westus",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderName": "Transaction-DS1_v2",
        "term": "P1Y"
      },
      "tags": []
    },
    {
      "name": "201909091919",
      "type": "Microsoft.Consumption/reservationTransactions",
      "id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919",
      "properties": {
        "description": "Standard_DS1_v2 westus 1 Year",
        "accountName": "Microsoft Infrastructure",
        "accountOwnerEmail": "admin@microsoft.com",
        "amount": 21,
        "armSkuName": "Standard_DS1_v2",
        "billingFrequency": "recurring",
        "billingMonth": 20190901,
        "costCenter": "",
        "currency": "USD",
        "currentEnrollment": "123456",
        "departmentName": "Unassigned",
        "eventDate": "2019-09-09T19:19:04Z",
        "eventType": "Purchase",
        "monetaryCommitment": 523123.9,
        "overage": 23234.49,
        "purchasingEnrollment": "123456",
        "purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2",
        "purchasingSubscriptionName": "Infrastructure Subscription",
        "quantity": 1,
        "region": "westus",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderName": "Transaction-DS1_v2",
        "term": "P1Y"
      },
      "tags": []
    }
  ]
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ReservationTransaction	Foglalási tranzakció erőforrása.
ReservationTransactionsListResult	Foglalási javaslatok listázásának eredménye.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ReservationTransaction

Tárgy

Foglalási tranzakció erőforrása.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.accountName	string	A tranzakciót lebonyolító fiók neve.
properties.accountOwnerEmail	string	A tranzakciót lebonyolító fióktulajdonos e-mail-címe.
properties.amount	number (decimal)	A tranzakció díja.
properties.armSkuName	string	Ez az ARM termékváltozat neve. A serviceType mezővel a használati rekordok további információiban való csatlakozásra használható.
properties.billingFrequency	string	A számlázási gyakoriság, amely lehet egyszeri vagy ismétlődő.
properties.billingMonth	integer (int32)	A számlázási hónap (yyyyMMdd), amelyen az esemény elindult.
properties.costCenter	string	A részleg költségközpontja, ha részleg és költséghely van megadva.
properties.currency	string	Az ISO pénznem, amelyben a tranzakciót felszámítják, például USD.
properties.currentEnrollment	string	Az aktuális regisztráció.
properties.departmentName	string	A részleg neve.
properties.description	string	A tranzakció leírása.
properties.eventDate	string (date-time)	A tranzakció dátuma
properties.eventType	string	A tranzakció típusa (Vásárlás, Lemondás vagy Visszatérítés).
properties.monetaryCommitment	number (decimal)	A pénzügyi keret összege a regisztrációs hatókörben.
properties.overage	number (decimal)	A túlhasználat összege a regisztrációs hatókörben.
properties.purchasingEnrollment	string	A vásárlási regisztráció.
properties.purchasingSubscriptionGuid	string (uuid)	A tranzakciót okozó előfizetési guid.
properties.purchasingSubscriptionName	string	A tranzakciót okozó előfizetés neve.
properties.quantity	number (decimal)	A tranzakció mennyisége.
properties.region	string	A tranzakció régiója.
properties.reservationOrderId	string	A foglalási rendelés azonosítója egy foglalásvásárlás azonosítója. Minden foglalási rendelés azonosítója egyetlen vásárlási tranzakciót jelöl. A foglalási rendelés foglalásokat tartalmaz. A foglalási sorrend határozza meg a foglalások virtuális gépének méretét és régióját.
properties.reservationOrderName	string	A foglalási rendelés neve.
properties.term	string	Ez a tranzakció időtartama.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
tags	string[]	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ReservationTransactionsListResult

Tárgy

Foglalási javaslatok listázásának eredménye.

Name	Típus	Description
nextLink	string	Az eredmények következő oldalára mutató hivatkozás (URL- cím).
value	ReservationTransaction[]	A foglalási javaslatok listája.

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.