Visão geral das APIs de Relatório do Azure Enterprise

  • Artigo

Observação

Todas as APIs de Relatórios Corporativos do Azure foram desativadas. Você deve migrar para as APIs de gerenciamento de custos da Microsoft o mais rápido possível.

As APIs de Relatórios do Azure Enterprise permitem que clientes Enterprise do Azure efetuem pull de modo programático dos dados de consumo e cobrança nas ferramentas preferidas de análise de dados. Os clientes corporativos assinaram um Enterprise Agreement (EA) com o Azure para fazer o Pré-pagamento do Azure negociado (anteriormente chamado de compromisso monetário) e obter acesso a preços personalizados para recursos do Azure.

Todos os parâmetros de data e hora necessários para as APIs devem ser representados como valores combinados de UTC (Tempo Universal Coordenado). Os valores retornados por APIs são mostrados em formato UTC.

Habilitando o acesso a dados para a API

  • Gerar ou recuperar a chave de API - Para obter mais informações, consulte Geração de chave de API.
  • Passando chaves na API: a chave de API precisa ser passada para cada chamada de Autenticação e Autorização. A propriedade a seguir precisa ser para os cabeçalhos HTTP.
Chave de cabeçalho da solicitação Valor
Autorização Especifique o valor neste formato: portador {API_KEY}
Exemplo: portador e... 09

APIs baseadas no consumo

Um ponto de extremidade Swagger está disponível aqui para as seguintes APIs. Eles devem permitir a introspecção fácil da API e a capacidade de gerar kits de desenvolvimento de software (SDK) cliente usando AutoRest ou Swagger CodeGen. Os dados a partir de 1º de maio de 2014 estão disponíveis por essa API.

  • Saldo e Resumo - A API Saldo e Resumo oferece um resumo mensal de informações sobre saldos, novas compras, cobranças de serviço do Azure Marketplace, ajustes e cobranças extras.

  • Detalhes de Uso: a API Detalhes de Uso oferece um detalhamento diário das quantidades consumidas e de encargos estimados por um registro. O resultado também inclui informações sobre instâncias, medidores e departamentos. Consulte a API por período de faturamento ou por uma data de início e término especificada.

  • Cobrança da Loja do Marketplace - A API de Cobrança da Loja do Marketplace retorna a divisão das cobranças do marketplace com base no uso por dia para o Período de Cobrança especificado ou datas de início e término (as taxas únicas não estão incluídas).

  • Tabela de Preços: a API Tabela de Preços fornece a taxa aplicável de cada Medidor para o Registro e o Período de Cobrança determinados.

  • Detalhes da Instância Reservada – a API de Uso da Instância Reservada retorna o uso das compras da instância reservada. A API de encargos da instância reservada mostra as transações de cobrança feitas.

Atualização dos Dados

Etags são retornadas na resposta de todas as APIs acima. Uma alteração no Etag indica que os dados foram atualizados. Nas chamadas subsequentes à mesma API usando os mesmos parâmetros, passe o Etag capturado com a chave "If-None-Match" no cabeçalho da solicitação http. O código de status da resposta é NotModified se os dados não forem atualizados mais e nenhum dado for retornado. A API retorna o conjunto de dados completo para o período necessário sempre que houver uma alteração de etag.

APIs auxiliares

Listar Períodos de Cobrança: a API Períodos de Cobrança retorna uma lista de períodos de cobrança que têm dados de consumo para o Registro especificado em ordem cronológica inversa. Cada período contém uma propriedade que aponta para a rota da API dos quatro conjuntos de dados: BalanceSummary, UsageDetails, Encargos do Marketplace e Price Sheet.

Códigos de resposta da API

Código de status de resposta Mensagem Descrição
200 OK Nenhum erro
400 Solicitação incorreta Parâmetros inválidos – intervalos de datas, números de EA, etc.
401 Não Autorizado Chave de API não encontrada, inválida, expirada, etc.
404 Indisponível Ponto de extremidade de relatório não encontrado
429 TooManyRequests A solicitação foi restringida. Tente novamente depois de aguardar o tempo especificado no cabeçalho x-ms-ratelimit-microsoft.consumption-retry-after.
500 Erro de servidor Erro inesperado ao processar a solicitação
503 ServiceUnavailable O serviço está temporariamente não disponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho Retry-After.