Reservation Transactions - List

Referencia

Servicio:: Consumption

Versión de la API:: 2024-08-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 la compra). Por ejemplo, el reembolso se solicita en mayo de 2021. Esta transacción de reembolso tendrá fecha de evento como mayo de 2021, pero el mes de facturación a abril de 2020 cuando se realizó la compra de la reserva. Nota: ARM tiene un límite de tamaño de carga de 12 MB, por lo que los autores de llamadas actualmente 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=2024-08-01

Con parámetros opcionales:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?$filter={$filter}&api-version=2024-08-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 fecha de inicio y 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 un asociado.

Respuestas

Nombre	Tipo	Description
200 OK	ReservationTransactionsListResult	De acuerdo. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ReservationTransactionsByEnrollmentNumber

Solicitud de ejemplo

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=2024-08-01&useMarkupIfPartner=True&previewMarkupPercentage=15.5

Respuesta de muestra

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 "Retry-After". Tiempo de espera de puerta de enlace 504: se agota el tiempo de espera del servicio mientras se procesa la solicitud. Reduzca el intervalo de fechas de la solicitud, si es posible.
ReservationTransaction	Recurso de transacción de reserva.
ReservationTransactionsListResult	Resultado de enumerar recomendaciones de reserva.

ErrorDetails

Object

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

Object

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 "Retry-After".
Tiempo de espera de puerta de enlace 504: se agota el tiempo de espera del servicio mientras se procesa la solicitud. Reduzca el intervalo de fechas de la solicitud, si es posible.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.