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 só suportam inscrições Enterprise, subscrições Web Direct (com algumas exceções) e subscrições do plano do Azure do CSP. 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 Clientes Enterprise
- Folha de preços
- Orçamentos
- Previsões
- Saldos
- Etiquetas
- Etiquetas de Custos
- Clientes Diretos Enterprise e Web
- Detalhes da Reserva
- Resumos da Reserva
- Encargos do Marketplace
- Detalhes de Utilização
- Recomendações da Reserva
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 Custos do Marketplace aceitam intervalos de datas ou período de faturação para definir as datas de início e de fim dos dados de utilização.
Eis o comportamento da API com base em períodos de faturação e intervalos de datas no pedido.
| 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 faturação atual são devolvidos em resposta |
| não | sim | não | Os dados do período de faturação atual são devolvidos em resposta |
| não | não | sim | Os dados do período de faturação atual são devolvidos em resposta |
| não | sim | sim | Os dados para a Data de Início e De Fim especificadas são devolvidos em resposta |
| sim | não | não | Os dados do período de faturação especificado são devolvidos em resposta |
| sim | sim | não | Os dados do período de faturação especificado são devolvidos em resposta |
| sim | não | sim | Os dados do período de faturação especificado são devolvidos em resposta |
| sim | sim | sim | Os dados da Data de Início e De Fim especificados são devolvidos em resposta, o período de faturação fornecido é ignorado |
O intervalo de datas máximo permitido é de 12 meses num pedido e os dados estão disponíveis a partir de 1 de maio de 2014 ou posterior.
Obter a lista de períodos de faturação
Para fornecer um período de faturação válido no pedido, o cliente deve obter primeiro uma lista dos períodos de faturação disponíveis por subscrição, com a seguinte API
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods?api-version=2017-04-24-preview
Com esta lista, o cliente pode escolher um período de faturação específico para obter dados de consumo.
Dados de Chegada Tardia
Para acomodar serviços de terceiros, que têm atrasos na comunicação da utilização, a data de utilização comunicada está definida para a hora em que os dados de utilização foram enviados, ao contrário de quando ocorreu a utilização real, ou seja, o tempo de consumo.
Como resultado, a utilização será classificada e aplicada à hora comunicada. Para representar o tempo de consumo real, as propriedades. O campo AdditionalProperties irá agora conter duas propriedades adicionais. ConsumptionBeginTime e ConsumptionEndTime são os novos campos que correspondem à janela de tempo de consumo real.
Estas alterações resultarão em alguns cenários que terão de ser resolvidos ao chamar a API de detalhes de utilização:
Relatórios de Fim de Mês: para a utilização que ocorreu durante um mês, mas reportada durante o mês seguinte, os clientes terão de analisar o campo additionalProperties para atribuir a utilização ao mês adequado.
Detalhes de Utilização da Consulta: ao consultar a API de detalhes de utilização por um intervalo de datas, a consulta aplica-se apenas à data do relatório de utilização e não ao tempo de consumo no campo additionalProperties . Para os clientes que pretendem mapear detalhes de utilização para faturas, esta atualização não afeta o processo, uma vez que a fatura processará a utilização com base na data do relatório de utilização. Para os clientes que procuram mapear os detalhes de utilização para uma data/mês de calendário específica, esta atualização é uma alteração interruptiva e, para estes cenários, não é possível utilizar a data do relatório de utilização e a data em que a utilização ocorreu, na secção additionalProperties tem de ser utilizada.
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
Fragmento 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"
}
}
Ver também
Para obter mais informações sobre como utilizar esta API num dos SDKs específicos do idioma, veja o seguinte
SDK de Python de Consumo do Azure