Consumo do Azure
As APIs de consumo do Azure lhe oferecem acesso programático a dados de uso e de custo para os recursos do Azure. Atualmente, as APIs dão suporte apenas a Registros Empresariais, assinaturas do Web Direct (com algumas exceções) e assinaturas de plano do Azure do CSP. As APIs são continuamente atualizadas para dar suporte a outros tipos de assinaturas do Azure.
As APIs de consumo do Azure fornecem acesso a:
- Somente clientes Enterprise
- Tabela de preços
- Orçamentos
- Previsões
- Saldos
- Marcações
- Marcas de custo
- Clientes Enterprise e Web Direct
- Detalhes da reserva
- Resumos da reserva
- Cobranças do Marketplace
- Detalhes de uso
- Recomendações de reserva
Lista de Tipos de Assinatura sem Suporte
- 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)
Trabalhando com períodos de cobrança e intervalos de datas
Os Detalhes de Uso e os Encargos do Marketplace aceitam período de cobrança ou intervalos de datas para definir as datas de início e término dos dados de uso.
Aqui está o comportamento da API com base em períodos de cobrança e intervalos de datas na solicitação.
| Período de cobrança presente na solicitação | Data de início presente na solicitação | Data de término presente na solicitação | Comportamento da API |
|---|---|---|---|
| não | não | não | Os dados do período de cobrança atual são retornados em resposta |
| não | sim | não | Os dados do período de cobrança atual são retornados em resposta |
| não | não | sim | Os dados do período de cobrança atual são retornados em resposta |
| não | sim | sim | Os dados da Data de Início e Término especificadas são retornados em resposta |
| sim | não | não | Os dados do período de cobrança especificado são retornados em resposta |
| sim | sim | não | Os dados do período de cobrança especificado são retornados em resposta |
| sim | não | sim | Os dados do período de cobrança especificado são retornados em resposta |
| sim | sim | sim | Os dados da Data de Início e Término especificadas são retornados em resposta, o período de cobrança 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.
Obtendo lista de períodos de cobrança
Para fornecer um período de cobrança válido na solicitação, o cliente deve primeiro obter uma lista de períodos de cobrança disponíveis por assinatura, usando a API a seguir
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 cobrança específico para obter dados de consumo.
Dados de chegada tardia
Para acomodar serviços de terceiros, que têm atrasos no uso de relatórios, a data de uso relatada é definida como a hora 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 para e aplicado à hora relatada. Para representar o tempo de consumo real, as propriedades. 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 resolvidos ao chamar a API de detalhes de uso:
Relatório de Fim de Mês: para uso que ocorreu durante um mês, mas relatado durante o próximo mês, os clientes precisarão examinar o campo adicionalPropriedades para atribuir o uso ao mês apropriado.
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 à hora de consumo no campo adicionalPropriedades . Para clientes que procuram mapear detalhes de uso para faturas, essa 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, procurando mapear detalhes de uso para uma data/mês de calendário específica, essa atualização é uma alteração interruptiva 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.
Chamada de exemplo para detalhes adicionais:
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails?api-version=2018-03-31&$expand=properties/additionalProperties
Snippet de resposta de exemplo:
"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"
}
}
Confira 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 do Azure Consumption