Partilhar via


Consumo do Azure

As APIs de Consumo do Azure oferecem acesso programático aos dados de custo e utilização para os seus recursos do Azure. Atualmente, as APIs suportam apenas Inscrições Empresariais, subscrições Web Direct (com algumas exceções) e subscrições do plano CSP Azure. As APIs são continuamente atualizadas para suportar outros tipos de subscrições do Azure.

As APIs de Consumo do Azure oferecem acesso a:

  • Apenas para clientes empresariais
    • Folha de preços
    • Orçamentos
    • Previsões
    • Saldos
    • Etiquetas
    • Etiquetas de Custo
  • Clientes Enterprise e Web Direct
    • Detalhes da Reserva
    • Resumos da Reserva
    • Encargos do Marketplace
    • Detalhes de Utilização
    • Recomendações de Reservas

Lista de Tipos de Subscrição Não Suportados

  • MS-AZR-0145P (CSP)
  • MS-AZR-0146P (CSP)
  • MS-AZR-159P (CSP)
  • MS-AZR-0036P (patrocinado)
  • MS-AZR-0143P (patrocinado)
  • MS-AZR-0015P (interno)
  • MS-AZR-0144P (DreamSpark)

Trabalhar com períodos de faturação e intervalos de datas

Os Detalhes de Utilização e os Encargos do Marketplace aceitam períodos de faturação ou intervalos de datas para definir as datas de início e fim dos dados de utilização.

Aqui está o comportamento da API com base em períodos de faturamento e intervalos de datas na solicitação.

Período de faturação presente no pedido Data de início presente no pedido Data de fim presente no pedido Comportamento da API
Não Não Não Os dados do período de faturamento atual são retornados em resposta
Não Sim Não Os dados do período de faturamento atual são retornados em resposta
Não Não Sim Os dados do período de faturamento atual são retornados em resposta
Não Sim Sim Os dados para as datas de início e término especificadas são retornados em resposta
Sim Não Não Os dados do período de faturamento especificado são retornados em resposta
Sim Sim Não Os dados do período de faturamento especificado são retornados em resposta
Sim Não Sim Os dados do período de faturamento especificado são retornados em resposta
Sim Sim Sim Os dados para as datas de início e término especificadas são retornados em resposta, o período de faturamento fornecido é ignorado

O intervalo máximo de datas permitido é de 12 meses em uma solicitação e os dados estão disponíveis a partir de 1º de maio de 2014 ou posterior.

Obter lista de períodos de faturação

Para fornecer um período de faturamento válido na solicitação, o cliente deve primeiro obter uma lista de períodos de faturamento disponíveis por assinatura, usando a seguinte API

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods?api-version=2017-04-24-preview

Usando essa lista, o cliente pode escolher um período de faturamento específico para obter dados de consumo.

Dados de chegada tardia

Para acomodar serviços de terceiros que tenham atrasos no relatório de uso, a data de uso relatada é definida para o momento em que os dados de uso foram enviados, em vez de quando o uso real ocorreu, ou seja, o tempo de consumo.

Como resultado, o uso será classificado e aplicado ao tempo relatado. A fim de representar o tempo de consumo real, os imóveis. O campo AdditionalProperties agora conterá duas propriedades adicionais. ConsumptionBeginTime e ConsumptionEndTime são os novos campos que correspondem à janela de tempo de consumo real.

Essas alterações resultarão em alguns cenários que precisarão ser abordados ao chamar a API de detalhes de uso:

  1. Relatório de fim de mês: para uso que ocorreu durante um mês, mas relatado durante o mês seguinte, os clientes precisarão examinar o campo additionalProperties para atribuir o uso ao mês apropriado.

  2. Detalhes de uso da consulta: ao consultar a API de detalhes de uso por um intervalo de datas, a consulta só se aplica à data do relatório de uso e não ao tempo de consumo no campo additionalProperties . Para clientes que desejam mapear detalhes de uso para faturas, esta atualização não afeta o processo, pois a fatura processará o uso com base na data do relatório de uso. Para os clientes que procuram mapear detalhes de uso para uma data/mês de calendário específico, esta atualização é uma alteração significativa e, para esses cenários, a data do relatório de uso não pode ser usada e a data em que o uso ocorreu, na seção additionalProperties , deve ser usada.

Exemplo de chamada para obter detalhes adicionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails?api-version=2018-03-31&$expand=properties/additionalProperties

Exemplo de trecho de resposta:

  "properties": {
    "billingPeriodId":"/subscriptions/{subscriptionid}/providers/Microsoft.Billing/billingPeriods/20180501",
    "usageStart":"2018-05-01T00:00:00.0000000Z",
    "usageEnd":"2018-05-01T23:59:59.0000000Z",
    "instanceId":"/subscriptions/{subscriptionid}/resourceGroups/{resourcegroup}/providers/Microsoft.Cdn/profiles/{profile}",
    "instanceName":"{id}",
    "instanceLocation":"SouthCentralUS",
    "meterId":"6b88ada0-cbc0-4874-be0e-23004f8b4de7",
    "usageQuantity":0.002065,
    "pretaxCost":0,
    "currency":"USD",
    "additionalProperties": {
      "Provider": "1",
      "ConsumptionBeginTime": "2018-05-01T19:00:00",
      "ConsumptionEndTime": "2018-05-01T20:00:00"
    }
  }

Ver também

Para obter mais informações sobre como usar essa API em um dos SDKs específicos do idioma, visite o seguinte

SDK do Python de Consumo do Azure

CLI de Consumo do Azure

Azure Consumption NodeJS SDK

SDK Ruby de Consumo do Azure