Reservation Transactions - List

Référence

Service:: Consumption

API Version:: 2023-05-01

Liste des transactions pour les instances réservées dans l’étendue du compte de facturation. Remarque : Les transactions de remboursement sont publiées avec leur transaction d’achat (c’est-à-dire dans le mois de facturation de l’achat). Par exemple, le remboursement est demandé en mai 2021. Cette transaction de remboursement aura la date de l’événement de mai 2021, mais le mois de facturation sera avril 2020 lorsque l’achat de la réservation a été effectué. Remarque : ARM a une limite de taille de charge utile de 12 Mo. Par conséquent, les appelants obtiennent actuellement 400 lorsque la taille de réponse dépasse la limite ARM. Dans ce cas, l’appel d’API doit être effectué avec des plages de dates plus petites.

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
billingAccountId	path	True	string	BillingAccount ID
api-version	query	True	string	Version de l’API à utiliser avec la demande du client. La version actuelle est 2023-03-01.
$filter	query		string	Filtrez les transactions de réservation par plage de dates. Propriétés/EventDate pour la date de début et la date de fin. Le filtre prend en charge « le » et « ge ». Remarque : l’API retourne des données pour l’ensemble du mois de facturation de la date de début et de la date de fin. Par exemple, les propriétés de filtre/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 incluront des données pour l’ensemble du mois de décembre 2020 (c’est-à-dire, contiendra des enregistrements pour les dates 30 et 31 décembre)
previewMarkupPercentage	query		number decimal	Pourcentage de balisage d’aperçu à appliquer.
useMarkupIfPartner	query		boolean	Applique la marque jusqu’aux transactions si l’appelant est un partenaire.

Réponses

Nom	Type	Description
200 OK	ReservationTransactionsListResult	OK. La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
ErrorDetails	Détails de l’erreur.
ErrorResponse	La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur. Réponses d’erreur : 429 TooManyRequests : la demande est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ». 503 ServiceUnavailable : le service est temporairement indisponible. Réessayez après avoir attendu le temps spécifié dans l’en-tête « Retry-After ».
ReservationTransaction	Ressource de transaction de réservation.
ReservationTransactionsListResult	Résultat de la liste des recommandations de réservation.

ErrorDetails

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Réponses d’erreur :

429 TooManyRequests : la demande est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ».
503 ServiceUnavailable : le service est temporairement indisponible. Réessayez après avoir attendu le temps spécifié dans l’en-tête « Retry-After ».

Nom	Type	Description
error	ErrorDetails	Détails de l’erreur.