Balances - Get By Billing Account

Serviço:: Consumption

Versão da API:: 2024-08-01

Obtém os saldos de um escopo por billingAccountId. Os saldos estão disponíveis por meio dessa API somente para 1º de maio de 2014 ou posterior.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances?api-version=2024-08-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
billingAccountId	path	True	string	ID da conta de cobrança
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	Balance	A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Balances

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/balances?api-version=2024-08-01

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
Balance	Um recurso de balanceamento.
BalancePropertiesAdjustmentDetailsItem
BalancePropertiesNewPurchasesDetailsItem
BillingFrequency	A frequência de cobrança.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
systemData	Metadados relativos à criação e última modificação do recurso.

Balance

Objeto

Um recurso de balanceamento.

Nome	Tipo	Description
etag	string	A etag do recurso.
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.adjustmentDetails	BalancePropertiesAdjustmentDetailsItem[]	Lista de ajustes (crédito promocional, crédito SIE etc.).
properties.adjustments	number (decimal)	Valor total do ajuste.
properties.azureMarketplaceServiceCharges	number (decimal)	Total de encargos para o Azure Marketplace.
properties.beginningBalance	number (decimal)	O saldo inicial do período de cobrança.
properties.billingFrequency	BillingFrequency	A frequência de cobrança.
properties.chargesBilledSeparately	number (decimal)	Encargos cobrados separadamente.
properties.currency	string	A moeda ISO na qual o medidor é cobrado, por exemplo, USD.
properties.endingBalance	number (decimal)	O saldo final do período de cobrança (para períodos abertos, isso será atualizado diariamente).
properties.newPurchases	number (decimal)	Valor total da nova compra.
properties.newPurchasesDetails	BalancePropertiesNewPurchasesDetailsItem[]	Lista de novas compras.
properties.overageRefund	number (decimal)	Reembolsos excedentes
properties.priceHidden	boolean	O preço está oculto ou não.
properties.serviceOverage	number (decimal)	Sobrecarga para serviços do Azure.
properties.totalOverage	number (decimal)	serviçoExcedente + encargosFaturadoSeparadamente.
properties.totalUsage	number (decimal)	Compromisso de serviço do Azure + sobrecarga total.
properties.utilized	number (decimal)	Uso total do Compromisso.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Marcas de recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BalancePropertiesAdjustmentDetailsItem

Objeto

Nome	Tipo	Description
name	string	o nome do novo ajuste.
value	number (decimal)	o valor do novo ajuste.

BalancePropertiesNewPurchasesDetailsItem

Objeto

Nome	Tipo	Description
name	string	o nome da nova compra.
value	number (decimal)	o valor da nova compra.

BillingFrequency

Enumeração

A frequência de cobrança.

Valor	Description
Month
Quarter
Year

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Balances - Get By Billing Account

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Balances

Solicitação de exemplo

Resposta de exemplo

Definições

Balance

BalancePropertiesAdjustmentDetailsItem

BalancePropertiesNewPurchasesDetailsItem

BillingFrequency

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData