Migrar da API de Detalhes de Uso do Consumo
Este artigo discute a migração da API de Detalhes de Uso de Consumo, que está prevista para ser preterida. A data exata da substituição ainda está sendo determinada. Recomendamos que você não crie seus pipelines de relatório usando essa API e migre para longe dela o mais rápido possível.
As APIs de relatório do EA (Contrato Enterprise), que usam uma chave de API para autenticação e são acessadas por meio do ponto de extremidade de URI consumption.azure.com, são desativadas. Os clientes de EA que usam essas APIs devem migrar para a API de Detalhes de Custo do Gerenciamento de Custos. Estas APIs de relatório do EA mais antigas só estão disponíveis para clientes com um Contrato Enterprise.
Se você usar a API Consumption Usage Details, recomendamos, mas não exigimos que você migre para a API de Detalhes de Custo do Gerenciamento de Custos.
As APIs de Consumo e Gerenciamento de Custos estão disponíveis para os clientes do MCA (Contrato de Cliente do Microsoft EA). Portanto, os clientes do Azure Governamental 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 Escolher uma solução de detalhes de custo, antes de escolher qual solução é adequada para a carga de trabalho. Em geral, recomendamos as 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, confira Ingerir dados de detalhes de uso.
Se você tiver um conjunto de dados de detalhes de uso menor ou um cenário que não seja atendido pelas Exportações, use o relatório Detalhes de Custo. Para obter mais informações, confira Obter pequenos conjuntos de dados de custo sob demanda.
Observação
O relatório Detalhes de Custo só está disponível para clientes com um Contrato Enterprise ou Contrato de Cliente da Microsoft. Se você tiver uma assinatura de MSDN, pagamento conforme o uso ou Visual Studio, poderá migrar para as Exportações ou continuar usando a API de Detalhes de Uso de Consumo.
Benefícios da migração
As novas soluções oferecem muitos benefícios em relação à API de Detalhes de Uso de Consumo. Segue um resumo:
- Conjunto de dados individual para todos os detalhes de uso – Os detalhes de uso do Azure e do Azure Marketplace foram mesclados em um conjunto de dados. Isso reduz o número de APIs que você precisa chamar para obter todos os encargos.
- 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 a transferência eficaz de grandes volumes de dados por uma rede com alta eficiência e confiabilidade. As exportações e a API de Detalhes de Custo são assíncronas. Elas fornecem um arquivo CSV que pode ser baixado diretamente pela rede.
- Melhorias de API – As Exportações e a API de Detalhes de Custo serão as soluções compatíveis com o Azure no futuro. Todos os novos recursos estão sendo integrados a elas.
- Consistência de esquema – O relatório de Detalhes de Custo e as Exportações fornecem aos arquivos os campos correspondentes que você pode mover de uma solução para outra, de acordo com o cenário.
- Integração de Alocação de Custos – Os clientes do Contrato Enterprise e do Contrato de Cliente da Microsoft que usam as Exportações ou a API de Detalhes de Custo podem exibir os encargos em relação às regras de alocação de custos que eles configuraram. Para obter mais informações sobre alocação de custos, confira 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 as Exportações/API de 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 Contrato Enterprise
Os clientes do Contrato Enterprise 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 Contrato Enterprise têm registros desse tipo, devido ao sistema de cobrança subjacente usado para eles. Veja 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 do 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 antigos e novos. Novas propriedades estão disponíveis nos arquivos CSV produzidos pelas Exportações e pela API de Detalhes de Custo. Para saber mais sobre os campos, confira Noções básicas sobre os campos de detalhes de uso.
Os nomes de propriedade em negrito não são alterados.
| Propriedade Antiga | Propriedade Nova |
|---|---|
| accountName | AccountName |
| AccountOwnerId | AccountOwnerId |
| additionalInfo | AdditionalInfo |
| AvailabilityZone | AvailabilityZone |
| billingAccountId | BillingAccountId |
| billingAccountName | BillingAccountName |
| billingCurrency | BillingCurrencyCode |
| billingPeriodEndDate | BillingPeriodEndDate |
| billingPeriodStartDate | BillingPeriodStartDate |
| billingProfileId | BillingProfileId |
| billingProfileName | BillingProfileName |
| chargeType | ChargeType |
| consumedService | ConsumedService |
| cost | CostInBillingCurrency |
| costCenter | CostCenter |
| data | Data |
| effectivePrice | EffectivePrice |
| frequência | Frequência |
| invoiceSection | InvoiceSectionName |
| InvoiceSectionId | InvoiceSectionId |
| isAzureCreditEligible | IsAzureCreditEligible |
| meterCategory | MeterCategory |
| meterId | MeterId |
| meterName | MeterName |
| MeterRegion | MeterRegion |
| meterSubCategory | MeterSubCategory |
| offerId | OfferId |
| partNumber | PartNumber |
| PayGPrice | PayGPrice |
| PlanName | PlanName |
| PricingModel | PricingModel |
| produto | ProductName |
| ProductOrderId | ProductOrderId |
| ProductOrderName | ProductOrderName |
| PublisherName | PublisherName |
| PublisherType | PublisherType |
| quantidade | Quantidade |
| ReservationId | ReservationId |
| ReservationName | ReservationName |
| resourceGroup | ResourceGroup |
| resourceId | ResourceId |
| resourceLocation | ResourceLocation |
| resourceName | ResourceName |
| serviceFamily | ServiceFamily |
| ServiceInfo1 | ServiceInfo1 |
| ServiceInfo2 | ServiceInfo2 |
| subscriptionId | SubscriptionId |
| subscriptionName | SubscriptionName |
| Marcas | Marcações |
| 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 da Microsoft têm registros desse tipo, devido ao sistema de cobrança subjacente usado para eles. Veja um exemplo de registro de detalhes de uso de MCA:
{
"value": [
{
"id": "{id}",
"name": "{name}",
"type": "Microsoft.Consumption/usageDetails",
"kind": "modern",
"tags": {
"env": "newcrp",
"dev": "tools"
},
"properties": {
…...
}
}
Um exemplo completo do registro de Detalhes de Uso herdado é mostrado em Detalhes de Uso – Lista – API REST (Consumo do Azure)
Um mapeamento entre os campos antigos e novos é mostrado na tabela a seguir. Novas propriedades estão disponíveis nos arquivos CSV produzidos pelas 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, confira Noções básicas sobre 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 |
| partnerName | partnerName |
| resellerName | resellerName |
| resellerMpnId | resellerMpnId |
| customerTenantId | customerTenantId |
| customerName | customerName |
| costCenter | costCenter |
| billingPeriodEndDate | billingPeriodEndDate |
| billingPeriodStartDate | billingPeriodStartDate |
| servicePeriodEndDate | servicePeriodEndDate |
| servicePeriodStartDate | servicePeriodStartDate |
| date | date |
| serviceFamily | serviceFamily |
| productOrderId | productOrderId |
| productOrderName | productOrderName |
| consumedService | consumedService |
| meterId | meterId |
| meterName | meterName |
| meterCategory | meterCategory |
| meterSubCategory | meterSubCategory |
| meterRegion | meterRegion |
| productIdentifier | ProductId |
| product | ProductName |
| subscriptionGuid | SubscriptionId |
| subscriptionName | subscriptionName |
| publisherType | publisherType |
| publisherId | publisherId |
| publisherName | publisherName |
| resourceGroup | resourceGroupName |
| NOMEDAINSTÂNCIA | ResourceId |
| resourceLocationNormalized | local |
| resourceLocation | local |
| effectivePrice | effectivePrice |
| quantidade | quantidade |
| unitOfMeasure | unitOfMeasure |
| chargeType | chargeType |
| billingCurrencyCode | billingCurrency |
| pricingCurrencyCode | pricingCurrency |
| costInBillingCurrency | costInBillingCurrency |
| costInPricingCurrency | costInPricingCurrency |
| costInUsd | costInUsd |
| paygCostInBillingCurrency | paygCostInBillingCurrency |
| paygCostInUSD | paygCostInUsd |
| exchangeRatePricingToBilling | exchangeRatePricingToBilling |
| exchangeRateDate | exchangeRateDate |
| isAzureCreditEligible | isAzureCreditEligible |
| serviceInfo1 | serviceInfo1 |
| serviceInfo2 | serviceInfo2 |
| additionalInfo | additionalInfo |
| tags | tags |
| partnerEarnedCreditRate | partnerEarnedCreditRate |
| partnerEarnedCreditApplied | partnerEarnedCreditApplied |
| marketPrice | PayGPrice |
| frequência | frequência |
| Termo | Termo |
| reservationId | reservationId |
| reservationName | reservationName |
| pricingModel | pricingModel |
| unitPrice | unitPrice |
| exchangeRatePricingToBilling | exchangeRatePricingToBilling |
Conteúdo relacionado
- Saiba mais sobre a automação de Gerenciamento de Custos e Cobrança na visão geral de automação de Gerenciamento de Custos.