Balances - Get For Billing Period By Billing Account

Referência

Service:: Consumption

API Version:: 2023-05-01

Obtém os saldos de um âmbito por período de faturação e faturaçãoAccountId. Os saldos só estão disponíveis através desta API para 1 de maio de 2014 ou posterior.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
billingAccountId	path	True	string	BillingAccount ID
billingPeriodName	path	True	string	Nome do Período de Faturação.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente. A versão atual é 2023-03-01.

Respostas

Name	Tipo	Description
200 OK	Balance	OK. O pedido foi efetuada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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

Definições

Name	Description
AdjustmentDetails	Lista de Ajustes (Crédito promocional, crédito SIE, etc.).
Balance	Um recurso de equilíbrio.
BillingFrequency	A frequência de faturação.
ErrorDetails	Os detalhes do erro.
ErrorResponse	A resposta de erro indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro. Algumas Respostas de erro: 429 TooManyRequests – o pedido é limitado. Repita depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable - O serviço está temporariamente indisponível. Tente novamente após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.
NewPurchasesDetails	Lista de novas compras.

AdjustmentDetails

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

Name	Tipo	Description
name	string	o nome do novo ajuste.
value	number	o valor do novo ajuste.

Balance

Um recurso de equilíbrio.

Name	Tipo	Description
etag	string	O etag do recurso.
id	string	O ID do ARM completamente qualificado de um evento.
name	string	O ID que identifica exclusivamente um evento.
properties.adjustmentDetails	AdjustmentDetails[]	Lista de Ajustes (Crédito promocional, crédito SIE, etc.).
properties.adjustments	number	Montante total de ajuste.
properties.azureMarketplaceServiceCharges	number	Total de custos de Azure Marketplace.
properties.beginningBalance	number	O saldo inicial do período de faturação.
properties.billingFrequency	BillingFrequency	A frequência de faturação.
properties.chargesBilledSeparately	number	Custos Faturados separadamente.
properties.currency	string	A moeda ISO na qual o medidor é cobrado, por exemplo, USD.
properties.endingBalance	number	O saldo final do período de faturação (para períodos abertos, este será atualizado diariamente).
properties.newPurchases	number	Valor total da nova compra.
properties.newPurchasesDetails	NewPurchasesDetails[]	Lista de novas compras.
properties.overageRefund	number	Reembolsos de Utilização Excedida
properties.priceHidden	boolean	O preço está oculto ou não.
properties.serviceOverage	number	Utilização excedida dos serviços do Azure.
properties.totalOverage	number	serviceOverage + chargesBilledSeparately.
properties.totalUsage	number	Alocação de serviço do Azure + Utilização Excedida total.
properties.utilized	number	Utilização total da Alocação.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

BillingFrequency

A frequência de faturação.

Name	Tipo	Description
Month	string
Quarter	string
Year	string

ErrorDetails

Os detalhes do erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro a indicar o motivo pela qual a operação falhou.

ErrorResponse

A resposta de erro indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

429 TooManyRequests – o pedido é limitado. Repita depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable - O serviço está temporariamente indisponível. Tente novamente após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

Name	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

NewPurchasesDetails

Lista de novas compras.

Name	Tipo	Description
name	string	o nome da nova compra.
value	number	o valor da nova compra.

Share via