Introducción a las API de Azure Enterprise Reporting

  • Artículo

Nota:

Todas las API de Azure Enterprise Reporting se retiran. Debe migrar a las API de Microsoft Cost Management lo antes posible.

Las API Azure Enterprise Reporting permiten a los clientes de Azure Enterprise extraer datos de facturación y consumo mediante programación en las herramientas de análisis de datos preferidas. Los clientes empresariales han firmado una Contrato Enterprise (EA) con Azure para realizar el pago por adelantado de Azure negociado (anteriormente denominado compromiso monetario) y obtener acceso a precios personalizados para los recursos de Azure.

Todos los parámetros de fecha y hora necesarios para las API deben representarse como valores combinados de Hora universal coordinada (UTC). Los valores devueltos por las API se muestran en formato UTC.

Habilitación del acceso de datos a la API

  • Generación o recuperación de la clave de API: para obtener más información, consulte Generación de claves de API.
  • Pasar claves en la API: la clave de API tiene que pasarse para cada llamada para la autenticación y autorización. La siguiente propiedad debe ser para los encabezados HTTP.
Clave de encabezado de solicitud Value
Authorization Especifique el valor con este formato: bearer {API_KEY}
Ejemplo: bearer eyr....09

API basados en consumo

Un punto de conexión de Swagger está disponible aquí para las siguientes API. Deben habilitar la introspección sencilla de la API y la capacidad de generar kits de desarrollo de software cliente (SDK) mediante AutoRest o Swagger CodeGen. Los datos a partir del 1 de mayo de 2014 están disponibles a través de esta API.

  • Saldo y resumen : la API balance y resumen ofrece un resumen mensual de información sobre saldos, nuevas compras, cargos de servicio de Azure Marketplace, ajustes y cargos por uso por encima del límite.

  • Detalles de uso: la API de detalles de uso ofrece un desglose diario de cantidades consumidas y gastos estimados por una inscripción. El resultado también incluye información sobre instancias, medidores y departamentos. Consulte la API por período de facturación o por una fecha de inicio y finalización especificada.

  • Cargo de la tienda de Marketplace: la API de cargo de la tienda de Marketplace devuelve el desglose de los cargos de Marketplace basados en el uso por día para el período de facturación especificado o las fechas de inicio y finalización (no se incluyen tarifas de una sola vez).

  • Hoja de precios: la API de hoja de precios proporciona el tipo aplicable de cada medidor para la inscripción y el período de facturación determinados.

  • Detalles de la instancia reservada: la API de uso de la instancia reservada devuelve el uso de las compras de la instancia reservada. La API de cargos de instancia reservada muestra las transacciones de facturación realizadas.

Actualización de datos

Las etiquetas Etag se devuelven en la respuesta de todas las API anteriores. Un cambio en Etag indica que se actualizaron los datos. En las sucesivas llamadas a la misma API con los mismos parámetros, pase la etiqueta ETag capturada con la clave "If-None-Match" en el encabezado de solicitud HTTP. El código de estado de respuesta es NotModified si los datos no se actualizan aún más y no se devuelve ningún dato. LA API devuelve el conjunto de datos completo durante el período necesario siempre que se produzca un cambio de etag.

API auxiliares

Enumerar períodos de facturación: la API de períodos de facturación devuelve una lista de períodos de facturación que tienen datos de consumo para la inscripción especificada en orden cronológico inverso. Cada período contiene una propiedad que señala a la ruta de la API para los cuatro conjuntos de datos: BalanceSummary, UsageDetails, Marketplace Charges y Price Sheet.

Códigos de respuesta de la API

Código de estado de respuesta Message Descripción
200 Aceptar Sin errores
400 Bad Request Parámetros no válidos: intervalos de fechas, números EA, etc.
401 No autorizado Clave de API no encontrada, no válida, expirada, etc.
404 No disponible Punto de conexión de informe no encontrado
429 TooManyRequests La solicitud se limitó. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado x-ms-ratelimit-microsoft.consumption-retry-after.
500 Error de servidor Error inesperado al procesar la solicitud
503 ServiceUnavailable El servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado Retry-After.