Reservation Transactions - List

Referencia

Service:: Consumption

API Version:: 2023-05-01

Lista de transacciones para instancias reservadas en el ámbito de la cuenta de facturación. Nota: Las transacciones de reembolso se contabilizan junto con su transacción de compra (es decir, en el mes de facturación de compra). Por ejemplo, el reembolso se solicita en mayo de 2021. Esta transacción de reembolso tendrá una fecha de evento como mayo de 2021, pero el mes de facturación a abril de 2020 cuando se realizó la compra de reserva. Nota: ARM tiene un límite de tamaño de carga de 12 MB, por lo que actualmente los autores de llamadas obtienen 400 cuando el tamaño de respuesta supera el límite de ARM. En tales casos, se debe realizar una llamada API con intervalos de fechas más pequeños.

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
billingAccountId	path	True	string	BillingAccount ID
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2023-03-01.
$filter	query		string	Filtre las transacciones de reserva por intervalo de fechas. Propiedades/EventDate para la fecha de inicio y la fecha de finalización. El filtro admite "le" y "ge". Nota: LA API devuelve datos para todo el mes de facturación de la fecha de inicio y la fecha de finalización. Por ejemplo, las propiedades de filtro/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 incluirán datos para todo el mes de diciembre de 2020 (es decir, contendrá registros para las fechas 30 y 31 de diciembre)
previewMarkupPercentage	query		number decimal	Porcentaje de marcado de vista previa que se va a aplicar.
useMarkupIfPartner	query		boolean	Aplica el marcado a las transacciones si el autor de la llamada es asociado.

Respuestas

Nombre	Tipo	Description
200 OK	ReservationTransactionsListResult	Aceptar. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. Algunas respuestas de error: 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Vuelva a intentarlo después de".
ReservationTransaction	Recurso de transacción de reserva.
ReservationTransactionsListResult	Resultado de enumerar las recomendaciones de reserva.

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponse

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Algunas respuestas de error:

429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Vuelva a intentarlo después de".

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.