Descrição geral da API de consumo do AzureAzure consumption API overview

As APIs de Consumo do Azure oferecem acesso programático aos dados de custo e utilização para os seus recursos do Azure.The Azure Consumption APIs give you programmatic access to cost and usage data for your Azure resources. Atualmente, estas APIs suportam apenas Inscrições Enterprise e Subscrições Web Direct (com algumas exceções).These APIs currently only support Enterprise Enrollments and Web Direct Subscriptions (with a few exceptions). As APIs são continuamente atualizadas para suportar outros tipos de subscrições do Azure.The APIs are continually updated to support other types of Azure subscriptions.

As APIs de Consumo do Azure oferecem acesso a:Azure Consumption APIs provide access to:

  • Clientes Diretos Enterprise e WebEnterprise and Web Direct Customers
    • Detalhes de UtilizaçãoUsage Details
    • Encargos do MarketplaceMarketplace Charges
    • Recomendações da ReservaReservation Recommendations
    • Detalhes da ReservaReservation Details
    • Resumos da ReservaReservation Summaries
  • Apenas Clientes EnterpriseEnterprise Customers Only
    • Folha de preçosPrice sheet
    • OrçamentosBudgets
    • SaldosBalances

API de Detalhes de UtilizaçãoUsage Details API

Utilize a API de Detalhes de Utilização para obter os dados de utilização e de custos de todos os recursos originais do Azure.Use the Usage Details API to get charge and usage data for all Azure 1st party resources. As informações estão na forma de registos de detalhes de utilização, que atualmente são emitidos uma vez por dia por medidor e por recurso.Information is in the form of usage detail records which are currently emitted once per meter per resource per day. As informações podem ser utilizadas para somar os custos em todos os recursos ou para investigar os custos/utilização em recursos específicos.Information can be used to add up the costs across all resources or investigate costs / usage on specific resource(s).

A API inclui:The API includes:

  • Dados de Consumo de Nível de Medição – veja os dados, incluindo o custo de utilização, o medidor que emite o custo e a que recurso do Azure pertence o custo.Meter Level Consumption Data - See data including usage cost, the meter emitting the charge, and what Azure resource the charge pertains to. Todos os registos de detalhes de utilização são mapeados para um registo diário.All usage detail records map to a daily bucket.
  • Azure control de acesso baseado em funções (Azure RBAC) - Configurar as políticas de acesso no portal Azure, os cmdlets Azure CLI ou Azure PowerShell para especificar quais os utilizadores ou aplicações que podem ter acesso aos dados de utilização da subscrição.Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. Os chamadores devem utilizar tokens do Azure Active Directory padrão para a autenticação.Callers must use standard Azure Active Directory tokens for authentication. Adicione o chamador à função Leitor de Faturação, Leitor, Proprietário ou Contribuidor para obter acesso aos dados de utilização de uma subscrição específica do Azure.Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Filtragem – corte o conjunto de resultados da API para obter um conjunto menor de registos de detalhes de utilização com os seguintes filtros:Filtering - Trim your API result set down to a smaller set of usage detail records using the following filters: - Fim de utilização/início de utilizaçãoUsage end / usage start - Grupo de RecursosResource Group - Nome do RecursoResource Name
  • Agregação de Dados – utilize o OData para aplicar expressões para agregar os detalhes de utilização por etiquetas ou propriedades de filtroData Aggregation - Use OData to apply expressions to aggregate usage details by tags or filter properties
  • Utilização para diferentes tipos de oferta – as informações de detalhes de utilização estão atualmente disponíveis para clientes Enterprise e Web Direct.Usage for different offer types - Usage detail information is currently available for Enterprise and Web Direct customers.

Para obter mais informações, veja a especificação técnica da Usage Details API (API de Detalhes de Utilização).For more information, see the technical specification for the Usage Details API.

API de Custos do MarketplaceMarketplace Charges API

Utilize a API de Custos do Marketplace para obter dados de utilização e de custos em todos os recursos do Marketplace (ofertas de terceiros do Azure).Use the Marketplace Charges API to get charge and usage data on all Marketplace resources (Azure 3rd party offerings). Estes dados podem ser utilizados para somar os custos em todos os recursos do Marketplace ou para investigar os custos/utilização num recurso ou em recursos específicos.This data can be used to add up costs across all Marketplace resources or investigate costs / usage on specific resource(s).

A API inclui:The API includes:

  • Dados de Consumo de Nível de Medição – veja os dados, incluindo o custo de utilização do Marketplace, o medidor que emite o encargo e a que recurso pertence o encargo.Meter Level Consumption Data - See data including marketplace usage cost, the meter emitting the charge, and what resource the charge pertains to. Todos os registos de detalhes de utilização são mapeados para um registo diário.All usage detail records map to a daily bucket.
  • Azure control de acesso baseado em funções (Azure RBAC) - Configurar as políticas de acesso no portal Azure, os cmdlets Azure CLI ou Azure PowerShell para especificar quais os utilizadores ou aplicações que podem ter acesso aos dados de utilização da subscrição.Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. Os chamadores devem utilizar tokens do Azure Active Directory padrão para a autenticação.Callers must use standard Azure Active Directory tokens for authentication. Adicione o chamador à função Leitor de Faturação, Leitor, Proprietário ou Contribuidor para obter acesso aos dados de utilização de uma subscrição específica do Azure.Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Filtragem – corte o conjunto de resultados da API para obter um conjunto menor de registos do Marketplace com os seguintes filtros:Filtering - Trim your API result set down to a smaller set of marketplace records using the following filters: - Início de utilização/fim de utilizaçãoUsage start / usage end - Grupo de RecursosResource Group - Nome do RecursoResource Name
  • Utilização para diferentes tipos de oferta – as informações do Marketplace estão atualmente disponíveis para clientes Enterprise e Web Direct.Usage for different offer types - Marketplace information is currently available for Enterprise and Web Direct customers.

Para obter mais informações, veja a especificação técnica da Marketplace Charges API (API de Encargos do Marketplace).For more information, see the technical specification for the Marketplace Charges API.

API de SaldosBalances API

Os clientes Enterprise podem utilizar a API de Saldos para obter um resumo mensal das informações sobre os saldos, as novas compras, os custos dos serviços do Azure Marketplace, os ajustes e os custos de utilização excedida.Enterprise customers can use the Balances API to get a monthly summary of information on balances, new purchases, Azure Marketplace service charges, adjustments, and overage charges. Pode obter estas informações para o período de faturação atual ou para qualquer período no passado.You can get this information for the current billing period or any period in the past. As empresas podem utilizar estes dados para fazer uma comparação com os custos de resumo calculados manualmente.Enterprises can use this data to perform a comparison with manually calculated summary charges. Esta API não fornece informações específicas dos recursos nem uma vista agregada dos custos.This API does not provide resource-specific information and an aggregate view of costs.

A API inclui:The API includes:

  • Azure control de acesso baseado em funções (Azure RBAC) - Configurar as políticas de acesso no portal Azure, os cmdlets Azure CLI ou Azure PowerShell para especificar quais os utilizadores ou aplicações que podem ter acesso aos dados de utilização da subscrição.Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. Os chamadores devem utilizar tokens do Azure Active Directory padrão para a autenticação.Callers must use standard Azure Active Directory tokens for authentication. Adicione o chamador à função Leitor de Faturação, Leitor, Proprietário ou Contribuidor para obter acesso aos dados de utilização de uma subscrição específica do Azure.Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Apenas Clientes Enterprise – esta API está disponível apenas para clientes EA.Enterprise Customers Only This API is only available EA customers. - Os clientes devem ter permissões de Administrador do Enterprise para chamar esta APICustomers must have Enterprise Admin permissions to call this API

Para obter mais informações, veja a especificação técnica da Balances API (API de Saldos).For more information, see the technical specification for the Balances API.

API de OrçamentosBudgets API

Os clientes Enterprise podem utilizar esta API para criar orçamentos de custo ou de utilização para recursos, grupos de recursos ou medidores de faturação.Enterprise customers can use this API to create either cost or usage budgets for resources, resource groups, or billing meters. Logo que estas informações tenham sido determinadas, podem ser configurados alertas para notificar quando forem excedidos os limiares de orçamento definidos pelo utilizador.Once this information has been determined, alerting can be configured to notify when user-defined budget thresholds are exceeded.

A API inclui:The API includes:

  • Azure control de acesso baseado em funções (Azure RBAC) - Configurar as políticas de acesso no portal Azure, os cmdlets Azure CLI ou Azure PowerShell para especificar quais os utilizadores ou aplicações que podem ter acesso aos dados de utilização da subscrição.Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. Os chamadores devem utilizar tokens do Azure Active Directory padrão para a autenticação.Callers must use standard Azure Active Directory tokens for authentication. Adicione o chamador à função Leitor de Faturação, Leitor, Proprietário ou Contribuidor para obter acesso aos dados de utilização de uma subscrição específica do Azure.Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Apenas Clientes Enterprise – esta API está apenas disponível para clientes EA.Enterprise Customers Only - This API is only available EA customers.
  • Notificações Configuráveis – especifique os utilizadores que serão notificados quando o orçamento for ultrapassado.Configurable Notifications - Specify user(s) to be notified when the budget is tripped.
  • Orçamentos com Base na Utilização ou no Custo – crie o seu orçamento com base no consumo ou no custo conforme a necessidade do seu cenário.Usage or Cost Based Budgets - Create your budget based on either consumption or cost as needed by your scenario.
  • Filtragem – filtre o seu orçamento para um subconjunto menor de recursos através dos seguintes filtros configuráveisFiltering - Filter your budget to a smaller subset of resources using the following configurable filters - Grupo de RecursosResource Group - Nome do RecursoResource Name - MedidorMeter
  • Períodos de tempo de orçamento configuráveis – especifique a frequência com que o orçamento deve ser redefinido e por quanto tempo o orçamento é válido.Configurable budget time periods - Specify how often the budget should reset and how long the budget is valid for.

Para obter mais informações, veja a especificação técnica da Budgets API (API de Orçamentos).For more information, see the technical specification for the Budgets API.

API de Recomendações de ReservasReservation Recommendations API

Utilize esta API para obter recomendações para comprar Instâncias de VM Reservadas.Use this API to get recommendations for purchasing Reserved VM Instances. As recomendações foram concebidas para permitir que os clientes analisem a poupança de custos e os valores de compra esperados.Recommendations are designed to allows customers to analyze expected cost savings and purchase amounts.

A API inclui:The API includes:

  • Azure control de acesso baseado em funções (Azure RBAC) - Configurar as políticas de acesso no portal Azure, os cmdlets Azure CLI ou Azure PowerShell para especificar quais os utilizadores ou aplicações que podem ter acesso aos dados de utilização da subscrição.Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. Os chamadores devem utilizar tokens do Azure Active Directory padrão para a autenticação.Callers must use standard Azure Active Directory tokens for authentication. Adicione o chamador à função Leitor de Faturação, Leitor, Proprietário ou Contribuidor para obter acesso aos dados de utilização de uma subscrição específica do Azure.Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Filtragem – personalize os seus resultados de recomendação com os seguintes filtros:Filtering - Tailor your recommendation results using the following filters: - ÂmbitoScope - Período retroativoLookback period
  • Informações de reserva para diferentes tipos de oferta – as informações de reserva estão atualmente disponíveis para clientes Enterprise e Web Direct.Reservation info for different offer types - Reservation information is currently available for Enterprise and Web Direct customers.

Para obter mais informações, veja a especificação técnica da Reservation Recommendations API (API de Recomendações de Reserva).For more information, see the technical specification for the Reservation Recommendations API.

API de Detalhes das ReservasReservation Details API

Utilize a API de Detalhes das Reservas para ver informações sobre as reservas de VMs compradas anteriormente, como a quantidade de consumo reservado versus o que está realmente a ser utilizado.Use the Reservation Details API to see info on previously purchased VM reservations such as how much consumption has been reserved versus how much is actually being used. Pode ver os dados ao nível da VM.You can see data at a per VM level detail.

A API inclui:The API includes:

  • Azure control de acesso baseado em funções (Azure RBAC) - Configurar as políticas de acesso no portal Azure, os cmdlets Azure CLI ou Azure PowerShell para especificar quais os utilizadores ou aplicações que podem ter acesso aos dados de utilização da subscrição.Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. Os chamadores devem utilizar tokens do Azure Active Directory padrão para a autenticação.Callers must use standard Azure Active Directory tokens for authentication. Adicione o chamador à função Leitor de Faturação, Leitor, Proprietário ou Contribuidor para obter acesso aos dados de utilização de uma subscrição específica do Azure.Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Filtragem – corte o conjunto de resultados da API para obter um conjunto menor de reservas com os seguintes filtros:Filtering - Trim your API result set down to a smaller set of reservations using the following filter: - Intervalo de datasDate range
  • Informações de reserva para diferentes tipos de oferta – as informações de reserva estão atualmente disponíveis para clientes Enterprise e Web Direct.Reservation info for different offer types - Reservation information is currently available for Enterprise and Web Direct customers.

Para obter mais informações, veja a especificação técnica da Reservation Details API (API de Detalhes de Reserva).For more information, see the technical specification for the Reservation Details API.

API de Resumos das ReservasReservation Summaries API

Utilize esta API para ver informações agregadas sobre as reservas de VMs compradas anteriormente, como a quantidade de consumo reservado versus o que está realmente a ser utilizado na agregação.Use this API to see aggregate information on previously purchased VM reservations such as how much consumption has been reserved versus how much is actually being used in the aggregate.

A API inclui:The API includes:

  • Azure control de acesso baseado em funções (Azure RBAC) - Configurar as políticas de acesso no portal Azure, os cmdlets Azure CLI ou Azure PowerShell para especificar quais os utilizadores ou aplicações que podem ter acesso aos dados de utilização da subscrição.Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. Os chamadores devem utilizar tokens do Azure Active Directory padrão para a autenticação.Callers must use standard Azure Active Directory tokens for authentication. Adicione o chamador à função Leitor de Faturação, Leitor, Proprietário ou Contribuidor para obter acesso aos dados de utilização de uma subscrição específica do Azure.Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Filtragem – personalize os seus resultados com um detalhamento diário com o seguinte filtro:Filtering - Tailor your results when using the daily grain with the following filter: - Data de UtilizaçãoUsage Date
  • Informações de reserva para diferentes tipos de oferta – as informações de reserva estão atualmente disponíveis para clientes Enterprise e Web Direct.Reservation info for different offer types - Reservation information is currently available for Enterprise and Web Direct customers.
  • Agregações diárias ou mensais – os chamadores podem especificar se querem os seus dados de resumo de reservas com detalhamento diário ou mensal.Daily or monthly aggregations – Callers can specify whether they want their reservation summary data in the daily or monthly grain.

Para obter mais informações, veja a especificação técnica da Reservation Summaries API (API de Resumos de Reserva).For more information, see the technical specification for the Reservation Summaries API.

API de Folha de PreçosPrice Sheet API

O cliente Enterprise pode utilizar esta API para obter os preços personalizados de todos os medidores.Enterprise customer can use this API to retrieve their custom pricing for all meters. As empresas podem utilizar esta API em combinação com os detalhes de utilização e as informações de utilização dos Marketplaces para calcular os custos com os dados de utilização e do Marketplace.Enterprises can use this in combination with usage details and marketplaces usage info to perform cost calculations using usage and marketplace data.

A API inclui:The API includes:

  • Azure control de acesso baseado em funções (Azure RBAC) - Configurar as políticas de acesso no portal Azure, os cmdlets Azure CLI ou Azure PowerShell para especificar quais os utilizadores ou aplicações que podem ter acesso aos dados de utilização da subscrição.Azure role-based access control (Azure RBAC) - Configure access policies on the Azure portal, the Azure CLI or Azure PowerShell cmdlets to specify which users or applications can get access to the subscription's usage data. Os chamadores devem utilizar tokens do Azure Active Directory padrão para a autenticação.Callers must use standard Azure Active Directory tokens for authentication. Adicione o chamador à função Leitor de Faturação, Leitor, Proprietário ou Contribuidor para obter acesso aos dados de utilização de uma subscrição específica do Azure.Add the caller to either the Billing Reader, Reader, Owner, or Contributor role to get access to the usage data for a specific Azure subscription.
  • Apenas Clientes Enterprise – esta API está apenas disponível para clientes EA.Enterprise Customers Only - This API is only available EA customers. Os clientes Web Direct devem utilizar a API RateCard para obter os preços.Web Direct customers should use the RateCard API to get pricing.

Para obter mais informações, veja a especificação técnica da Price Sheet API (API de Folha de Preços).For more information, see the technical specification for the Price Sheet API.

CenáriosScenarios

Veja a seguir alguns dos cenários que se tornaram possíveis com as APIs de consumo:Here are some of the scenarios that are made possible via the consumption APIs:

  • Reconciliação da Fatura – A Microsoft faturou-me o montante correto?Invoice Reconciliation - Did Microsoft charge me the right amount? De quanto é a minha fatura e posso ser eu a calculá-la?What is my bill and can I calculate it myself?
  • Encargos Cruzados – Agora que sei quanto está a ser faturado, quem na minha organização terá de pagar?Cross Charges - Now that I know how much I'm being charged, who in my org needs to pay?
  • Otimização de Custos – Sei o montante que me foi faturado...Cost Optimization - I know how much I've been charged… Como posso aproveitar ao máximo o dinheiro que estou a gastar no Azure?how can I get more out of the money I am spending on Azure?
  • Controlo de Custos – Quero ver quanto estou a gastar e como estou utilizar o Azure ao longo do tempo.Cost Tracking - I want to see how much I am spending and using Azure over time. Quais são as tendências?What are the trends? Como posso melhorar?How could I be doing better?
  • Azure gastar durante o mês - Quanto é que o meu mês atual gasta até à data?Azure spend during the month - How much is my current month's spend to date? É necessário fazer ajustes nos meus gastos e/ou na utilização do Azure?Do I need to make any adjustments in my spending and/or usage of Azure? Em que alturas do mês é maior o consumo do Azure?When during the month am I consuming Azure the most?
  • Configurar alertas – Gostaria de configurar alertas de consumo baseado em recursos ou alertas monetários com base num orçamento.Set up alerts - I would like to set up resource-based consumption or monetary-based alerting based on a budget.

Passos SeguintesNext Steps