Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
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 Corporativos, assinaturas 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 corporativos
- Tabela de preços
- Orçamentos
- Previsões
- Balances
- Etiquetas
- Etiquetas de custo
- Clientes corporativos e diretos da Web
- 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 (Faísca dos Sonhos)
Trabalhar com períodos de faturamento e intervalos de datas
Detalhes de uso e 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 baseado nos períodos de faturamento e intervalos de data em solicitação:
| Período de cobrança solicitado | Data de início no pedido | Data de término sob 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 a data de início e término especificada 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 cobrança fornecido é ignorado |
O período máximo permitido é de 12 meses em uma solicitação e os dados estão disponíveis a partir de 1º de maio de 2014.
Obtendo lista de períodos de cobrança
Para garantir um período de faturamento válido em uma solicitação, o cliente deve primeiro obter uma lista dos 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 a 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 apresentam atrasos no relato de uso, a data de uso reportada é definida para o momento em que os dados de uso foram enviados, em oposição ao momento em que o uso real ocorreu, ou seja, o tempo de consumo.
Como resultado, o uso é avaliado e aplicado ao tempo reportado. Para representar o tempo real de consumo, as propriedades. O campo Propriedades Adicionais agora conterá outras duas propriedades. ConsumptionBeginTime e ConsumptionEndTime são os novos campos que correspondem à janela de tempo de consumo real.
Essas mudanças resultam em alguns cenários que precisam ser abordados ao chamar a API de detalhes de uso:
Relatórios de Fim de Mês: Para o uso que ocorreu durante um mês, mas foi reportado no mês seguinte, os clientes precisam consultar o campo AdicionalalProperties para atribuir o uso ao mês apropriado.
Consulta Detalhes de Uso: Quando você consulta a API de detalhes de uso por um intervalo de datas, a consulta se aplica apenas à data do relatório de uso e não ao tempo de consumo no campo Propriedades Adicionais . Para clientes que desejam mapear detalhes de uso para as faturas, essa atualização não afeta o processo, pois a fatura processa o uso com base na data do relatório de uso. Para os clientes que desejam mapear detalhes de uso para uma data/mês específico do calendário, essa atualização é uma mudança significativa e, nesses casos, a data do relatório de uso não pode ser usada e a data em que o uso ocorreu, na seção Propriedades Adicionais , deve ser utilizada.
Chamada de exemplo para mais detalhes:
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails?api-version=2018-03-31&$expand=properties/additionalProperties
Exemplo de snippet 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"
}
}
Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos da linguagem, visite o seguinte
SDK do Python de Consumo do Azure