Balances - Get For Billing Period By Billing Account

Referencia

Service:: Consumption

API Version:: 2023-05-01

Obtiene los saldos de un ámbito por período de facturación y billingAccountId. Los saldos están disponibles a través de esta API solo para el 1 de mayo de 2014 o posterior.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances?api-version=2023-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
billingAccountId	path	True	string	BillingAccount ID
billingPeriodName	path	True	string	Nombre del período de facturación.
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.

Respuestas

Nombre	Tipo	Description
200 OK	Balance	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

Balances

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/billingPeriods/201702/providers/Microsoft.Consumption/balances?api-version=2023-05-01

Sample Response

Status code:: 200

{
  "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/balances/balanceId1",
  "name": "balanceId1",
  "type": "Microsoft.Consumption/balances",
  "properties": {
    "currency": "USD  ",
    "beginningBalance": 3396469.19,
    "endingBalance": 2922371.02,
    "newPurchases": 0,
    "adjustments": 0,
    "utilized": 474098.17,
    "serviceOverage": 0,
    "chargesBilledSeparately": 0,
    "totalOverage": 0,
    "totalUsage": 474098.17,
    "azureMarketplaceServiceCharges": 609.82,
    "billingFrequency": "Month",
    "priceHidden": false,
    "overageRefund": 2012.61,
    "newPurchasesDetails": [
      {
        "name": "Promo Purchase",
        "value": 1
      }
    ],
    "adjustmentDetails": [
      {
        "name": "Promo Credit",
        "value": 1.1
      },
      {
        "name": "SIE Credit",
        "value": 1
      }
    ]
  }
}

Definiciones

Nombre	Description
AdjustmentDetails	Lista de ajustes (crédito promocional, crédito SIE, etc.).
Balance	Un recurso de equilibrio.
BillingFrequency	Frecuencia de facturación.
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".
NewPurchasesDetails	Lista de nuevas compras.

AdjustmentDetails

Lista de ajustes (crédito promocional, crédito SIE, etc.).

Nombre	Tipo	Description
name	string	nombre del nuevo ajuste.
value	number	el valor del nuevo ajuste.

Balance

Un recurso de equilibrio.

Nombre	Tipo	Description
etag	string	ETag del recurso.
id	string	Identificador completo de ARM de un evento.
name	string	Identificador que identifica de forma única un evento.
properties.adjustmentDetails	AdjustmentDetails[]	Lista de ajustes (crédito promocional, crédito SIE, etc.).
properties.adjustments	number	Cantidad total de ajuste.
properties.azureMarketplaceServiceCharges	number	Total de cargos por Azure Marketplace.
properties.beginningBalance	number	Saldo inicial del período de facturación.
properties.billingFrequency	BillingFrequency	Frecuencia de facturación.
properties.chargesBilledSeparately	number	Cargos facturados por separado.
properties.currency	string	Moneda ISO en la que se cobra el medidor, por ejemplo, USD.
properties.endingBalance	number	El saldo final del período de facturación (para períodos abiertos se actualizará diariamente).
properties.newPurchases	number	Importe total de la compra nueva.
properties.newPurchasesDetails	NewPurchasesDetails[]	Lista de nuevas compras.
properties.overageRefund	number	Reembolsos por encima del límite
properties.priceHidden	boolean	El precio está oculto o no.
properties.serviceOverage	number	Uso por encima del límite de los servicios de Azure.
properties.totalOverage	number	serviceOverage + chargesBilledSeparately.
properties.totalUsage	number	Compromiso del servicio de Azure + uso por encima del límite total.
properties.utilized	number	Uso total del compromiso.
tags	object	Etiquetas del recurso.
type	string	Tipo de recurso.

BillingFrequency

Frecuencia de facturación.

Nombre	Tipo	Description
Month	string
Quarter	string
Year	string

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.

NewPurchasesDetails

Lista de nuevas compras.

Nombre	Tipo	Description
name	string	el nombre de la nueva compra.
value	number	el valor de la nueva compra.

Share via