APIs de Relatórios para clientes Enterprise – Saldo e Resumo

  • Artigo

Observação

Em 1º de maio de 2024, as APIs do Azure Enterprise Reporting serão desativadas. Todas as APIs de Relatórios Empresariais restantes deixarão de responder às solicitações. Os clientes precisam fazer a transição para o uso de APIs de Gerenciamento de Custos da Microsoft antes disso. Para saber mais, confira Migrar do Azure Enterprise Reporting para a visão geral das APIs de Gerenciamento de Custos da Microsoft.

A API Saldo e Resumo oferece um resumo mensal de informações sobre saldos, novas compras, encargos de serviço do Azure Marketplace, ajustes e encargos de excedente.

Solicitação

As propriedades do cabeçalho comuns que precisam ser adicionadas são especificadas no artigo Visão geral de APIs de relatórios para clientes Enterprise. Se um período de cobrança não for especificado, os dados do período de cobrança atual serão retornados.

Método URI da solicitação
GET https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/balancesummary
GET https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/billingPeriods/{billingPeriod}/balancesummary

Observação

Para usar a versão anterior da API, substitua v3 por v2 nas URLs acima. Alguns campos não estão disponíveis se você usar v2.

Resposta

        {
            "id": "enrollments/100/billingperiods/201507/balancesummaries",
              "billingPeriodId": 201507,
              "currencyCode": "USD",
              "beginningBalance": 0,
              "endingBalance": 1.1,
              "newPurchases": 1,
              "adjustments": 1.1,
              "utilized": 1.1,
              "serviceOverage": 1,
              "chargesBilledSeparately": 1,
              "totalOverage": 1,
              "totalUsage": 1.1,
              "azureMarketplaceServiceCharges": 1,
              "newPurchasesDetails": [
                {
                  "name": "",
                  "value": 1
                }
              ],
              "adjustmentDetails": [
                {
                  "name": "Promo Credit",
                  "value": 1.1
                },
                {
                  "name": "SIE Credit",
                  "value": 1.0
                }
              ]
        }

Definições da propriedade de resposta

Nome da propriedade Tipo Descrição
id string A ID exclusiva de um determinado período de cobrança e registro
billingPeriodId string A ID do período de cobrança
currencyCode string O código da moeda
beginningBalance decimal O saldo inicial para o período de cobrança
endingBalance decimal O saldo final do período de cobrança (para períodos abertos ele será atualizado diariamente)
newPurchases decimal Valor total da nova compra
adjustments decimal Valor total do ajuste
utilized decimal Uso total do compromisso
serviceOverage decimal Excedente dos serviços do Azure
chargesBilledSeparately decimal Encargos cobrados separadamente
totalOverage decimal serviceOverage + chargesBilledSeparately
totalUsage decimal Compromisso do serviço do Azure + excedente total
azureMarketplaceServiceCharges decimal Total de encargos do Azure Marketplace
newPurchasesDetails Matriz de cadeias de caracteres JSON de pares de nome e valor Lista de novas compras
adjustmentDetails Matriz de cadeias de caracteres JSON de pares de nome e valor Lista de ajustes (crédito de promoção, crédito SIE etc.)

Confira também