Migrar da API de Detalhes de Uso de Consumo
Este artigo discute a migração da API de Detalhes de Uso de Consumo, que está planejada para descontinuação. A data exata da depreciação ainda está sendo determinada. Recomendamos que você não crie seus pipelines de relatórios usando essa API e migre dela o mais rápido possível.
As APIs de relatório do Enterprise Agreement (EA), que usam uma chave de API para autenticação e são acessadas por meio do ponto de extremidade URI consumption.azure.com, são desativadas. Os clientes da EA que usam essas APIs devem migrar para a API de Detalhes de Custo do Gerenciamento de Custos . Essas APIs de relatórios EA mais antigas só estão disponíveis para clientes com um Enterprise Agreement.
Se você usar a API de Detalhes de Uso de Consumo, recomendamos, mas não exigimos que você migre para a API de Detalhes de Custo de Gerenciamento de Custos.
As APIs de Gestão de Consumo e Custos estão disponíveis para ambos os clientes EA Microsoft Customer Agreement (MCA). Portanto, os clientes do Azure Government que permanecem sob um EA não são afetados negativamente.
Ao migrar do EA para o MCA, recomendamos que você mude da API de Detalhes de Uso de relatórios do EA para a API de Detalhes de Custo de Gerenciamento de Custos e use Exportações.
Destinos de migração
Leia o artigo Escolha uma solução de detalhes de custo antes de escolher qual é a solução certa para sua carga de trabalho. Geralmente, recomendamos Exportações se você tiver necessidades contínuas de ingestão de dados e ou um grande conjunto de dados de detalhes de uso mensal. Para obter mais informações, consulte Dados de detalhes de uso da ingestão.
Se você tiver um conjunto de dados de detalhes de uso menor ou um cenário que não seja atendido por Exportações, considere usar o relatório Detalhes de custo . Para obter mais informações, consulte Obter conjuntos de dados de pequeno custo sob demanda.
Nota
O relatório Detalhes de Custo só está disponível para clientes com um Enterprise Agreement ou um Contrato de Cliente Microsoft. Se você tiver uma assinatura MSDN, paga conforme o uso ou Visual Studio, poderá migrar para Exportações ou continuar usando a API de Detalhes de Uso do Consumo.
Benefícios da migração
As novas soluções oferecem muitos benefícios em relação à API de Detalhes de Uso de Consumo. Aqui está um resumo:
- Conjunto de dados único para todos os detalhes de uso - os detalhes de uso do Azure e do Azure Marketplace foram mesclados em um conjunto de dados. Ele reduz o número de APIs que você precisa ligar para ver todas as suas cobranças.
- Escalabilidade - A API do Marketplaces foi preterida porque promove um padrão de chamada que não pode ser dimensionado à medida que o uso do Azure aumenta. O conjunto de dados de detalhes de uso pode ficar grande à medida que você implanta mais recursos na nuvem. A API do Marketplaces é uma API síncrona paginada, portanto, não é otimizada para transferir efetivamente grandes volumes de dados em uma rede com alta eficiência e confiabilidade. As exportações e a API de detalhes de custo são assíncronas. Eles fornecem um arquivo CSV que pode ser baixado diretamente pela rede.
- Melhorias da API - Exportações e a API de Detalhes de Custo são as soluções que o Azure suporta no futuro. Todos os novos recursos estão sendo integrados a eles.
- Consistência do esquema - O relatório Detalhes de custo e as exportações fornecem arquivos com campos correspondentes que você pode mover de uma solução para outra, com base no seu cenário.
- Integração de alocação de custos - os clientes do Enterprise Agreement e do Microsoft Customer Agreement que usam Exportações ou a API de Detalhes de Custo podem exibir cobranças em relação às regras de alocação de custos que eles configuraram. Para obter mais informações sobre alocação de custos, consulte Alocar custos.
Diferenças de campo
A tabela a seguir resume as diferenças de campo entre a API de Detalhes de Uso de Consumo e a API de Exportações/Detalhes de Custo. As exportações e a API de Detalhes de Custo fornecem um download de arquivo CSV em vez da resposta JSON paginada fornecida pela API de Consumo.
Mapeamento de campo do Enterprise Agreement
Os clientes do Enterprise Agreement que estão usando a API de Detalhes de Uso de Consumo têm registros de detalhes de uso do tipo legacy. Todos os clientes do Enterprise Agreement têm registos deste tipo devido ao sistema de faturação subjacente que lhes é utilizado. Aqui está um exemplo de registro de detalhes de uso herdado:
{
"value": [
{
"id": "{id}",
"name": "{name}",
"type": "Microsoft.Consumption/usageDetails",
"kind": "legacy",
"tags": {
"env": "newcrp",
"dev": "tools"
},
"properties": {
…...
}
}
Um exemplo completo de registro de Detalhes de Uso herdado é mostrado em Detalhes de Uso - Lista - API REST (Consumo do Azure)
A tabela a seguir fornece um mapeamento entre os campos antigo e novo. Novas propriedades estão disponíveis nos arquivos CSV produzidos por Exportações e pela API de detalhes de custo. Para saber mais sobre os campos, consulte Compreender os campos de detalhes de utilização.
Os nomes de propriedade em negrito permanecem inalterados.
| Propriedade Antiga | Propriedade Nova |
|---|---|
| accountName | AccountName |
| AccountOwnerId | AccountOwnerId |
| additionalInfo | AdditionalInfo |
| Zona de Disponibilidade | AvailabilityZone |
| billingAccountId | BillingAccountId |
| billingAccountName | BillingAccountName |
| billingCurrency | FaturaçãoMoedaCódigo |
| billingPeriodEndDate | BillingPeriodEndDate |
| billingPeriodStartDate | BillingPeriodStartDate |
| billingProfileId | BillingProfileId |
| billingProfileName | BillingProfileName |
| chargeType | ChargeType |
| consumedService | ConsumedService |
| custo | CostInBillingCurrency |
| costCenter | CostCenter |
| data | Date |
| effectivePrice | EffectivePrice |
| frequency | Frequência |
| invoiceSection | InvoiceSectionName |
| InvoiceSectionId | InvoiceSectionId |
| isAzureCreditEligible | IsAzureCreditEligible |
| meterCategory | MeterCategory |
| meterId | MeterId |
| meterName | MeterName |
| MeterRegion | MeterRegion |
| meterSubCategory | MeterSubCategory |
| offerId | OfferId |
| partNumber | PartNumber |
| PayGPrice | PayGPrice |
| Nome do Plano | PlanName |
| Modelo de Preços | PricingModel |
| produto | ProductName |
| ProductOrderId | ProductOrderId |
| ProductOrderName | ProductOrderName |
| Nome do editor | Nome do Editor |
| Tipo de Editor | PublisherType |
| quantidade | Quantidade |
| ReservationId | ReservationId |
| ReservationName | ReservationName |
| resourceGroup | ResourceGroup |
| resourceId | ResourceId |
| resourceLocation | ResourceLocation |
| resourceName | ResourceName |
| serviceFamily | ServiceFamily |
| ServiçoInfo1 | ServiceInfo1 |
| ServiceInfo2 | ServiceInfo2 |
| subscriptionId | SubscriptionId |
| subscriptionName | SubscriptionName |
| Etiquetas | Etiquetas |
| Termo | Termo |
| unitOfMeasure | UnitOfMeasure |
| unitPrice | UnitPrice |
| CostAllocationRuleName | CostAllocationRuleName |
Mapeamento de campo do Contrato de Cliente da Microsoft
Os clientes do Contrato de Cliente da Microsoft que usam a API de Detalhes de Uso de Consumo têm registros de detalhes de uso do tipo modern. Todos os clientes do Contrato de Cliente Microsoft têm registos deste tipo devido ao sistema de faturação subjacente que lhes é utilizado. Aqui está um exemplo de registro de detalhes de uso do MCA:
{
"value": [
{
"id": "{id}",
"name": "{name}",
"type": "Microsoft.Consumption/usageDetails",
"kind": "modern",
"tags": {
"env": "newcrp",
"dev": "tools"
},
"properties": {
…...
}
}
Um exemplo completo de registro de Detalhes de Uso herdado é mostrado em Detalhes de Uso - Lista - API REST (Consumo do Azure)
Um mapeamento entre os campos antigo e novo é mostrado na tabela a seguir. Novas propriedades estão disponíveis nos arquivos CSV produzidos por Exportações e pela API de detalhes de custo. Os campos que precisam de um mapeamento devido a diferenças entre as soluções são mostrados em negrito.
Para obter mais informações, consulte Compreender os campos de detalhes de uso.
| Propriedade antiga | Nova propriedade |
|---|---|
| invoiceId | invoiceId |
| previousInvoiceId | previousInvoiceId |
| billingAccountId | billingAccountId |
| billingAccountName | billingAccountName |
| billingProfileId | billingProfileId |
| billingProfileName | billingProfileName |
| invoiceSectionId | invoiceSectionId |
| invoiceSectionName | invoiceSectionName |
| partnerTenantId | partnerTenantId |
| Nome do parceiro | Nome do parceiro |
| nome do revendedor | nome do revendedor |
| revendedorMpnId | revendedorMpnId |
| customerTenantId | customerTenantId |
| nome_do_cliente | nome_do_cliente |
| costCenter | costCenter |
| billingPeriodEndDate | billingPeriodEndDate |
| billingPeriodStartDate | billingPeriodStartDate |
| servicePeriodEndDate | servicePeriodEndDate |
| servicePeriodStartDate | servicePeriodStartDate |
| data | data |
| serviceFamily | serviceFamily |
| productOrderId | productOrderId |
| productOrderName | productOrderName |
| consumedService | consumedService |
| meterId | meterId |
| meterName | meterName |
| meterCategory | meterCategory |
| meterSubCategory | meterSubCategory |
| meterRegion | meterRegion |
| productIdentifier | Identificação do produto |
| produto | Nome do Produto |
| subscriptionGuid | SubscriptionId |
| subscriptionName | subscriptionName |
| publisherType | publisherType |
| editorId | editorId |
| publisherName | publisherName |
| resourceGroup [en] | resourceGroupName |
| instanceName | ResourceId |
| resourceLocationNormalizado | localização |
| resourceLocalização | localização |
| effectivePrice | effectivePrice |
| quantidade | quantidade |
| unitOfMeasure | unitOfMeasure |
| chargeType | chargeType |
| billingCurrencyCode | billingCurrency |
| preçoMoedaCódigo | preçoMoeda |
| costInBillingCurrency | costInBillingCurrency |
| costInPricingCurrency | costInPricingCurrency |
| costInUsd | costInUsd |
| paygCostInBillingCurrency | paygCostInBillingCurrency |
| paygCostInUSD | paygCostInUsd |
| câmbioTaxaPreçoparaFaturação | câmbioTaxaPreçoparaFaturação |
| exchangeRateDate | exchangeRateDate |
| isAzureCreditEligible | isAzureCreditEligible |
| serviceInfo1 | serviceInfo1 |
| serviceInfo2 | serviceInfo2 |
| additionalInfo | additionalInfo |
| etiquetas | etiquetas |
| partnerEarnedCreditRate | partnerEarnedCreditRate |
| partnerEarnedCreditApplied | partnerEarnedCreditApplied |
| mercadoPreço de mercado | PayGPrice |
| frequency | frequency |
| vigência | vigência |
| reservationId | reservationId |
| reservationName | reservationName |
| modelo de preços | modelo de preços |
| unitPrice | unitPrice |
| câmbioTaxaPreçoparaFaturação | câmbioTaxaPreçoparaFaturação |
Conteúdos relacionados
- Saiba mais sobre Gestão de Custos + Automação de Faturação em Visão geral da automação de Gestão de Custos.