Migrar das APIs de Detalhes de Uso do EA
Os clientes com EA que usavam as APIs de Relatórios Empresariais por trás do ponto de extremidade consumption.azure.com para obter os detalhes de uso e os encargos do marketplace precisam migrar para soluções novas e aprimoradas. As instruções são descritas abaixo, juntamente com as diferenças contratuais entre a API antiga e as novas soluções.
O conjunto de dados é chamado de detalhes de custo em vez de detalhes de uso.
Observação
Todas as APIs do Azure Enterprise Reporting foram descontinuadas. Você deve Migrar para as APIs de Gerenciamento de Custos da Microsoft o mais rápido possível.
Novas soluções em disponibilidade geral
A tabela a seguir fornece um resumo dos destinos de migração disponíveis, bem como um resumo do que considerar ao escolher qual solução é melhor para você.
| Solução | Descrição | Considerações | Informações de integração |
|---|---|---|---|
| Exportações | Despejos de dados recorrentes no armazenamento segundo um agendamento | – A solução mais escalonável para suas cargas de trabalho. – Pode ser configurado para usar o particionamento de arquivos para conjuntos de dados maiores. – Ótimo para estabelecer e ampliar um conjunto de dados de custo que pode ser integrado com seus armazenamentos de dados consultáveis. – Requer acesso a uma conta de armazenamento que pode conter os dados. |
- Configurar no portal do Azure Automatizar a criação de Exportação com a API - Referência da API de Exportação |
| API de Detalhes de Custo | Download sob demanda | – Útil para pequenos conjuntos de dados de custo. – Útil para cenários em que exportações para o armazenamento do Azure não são viáveis devido a questões de segurança ou de gerenciamento. |
- Obter pequenos conjuntos de dados de custo sob demanda - API de Detalhes de Custo |
De modo geral, recomendamos usar Exportações se você tem necessidades contínuas de ingestão de dados e/ou um grande conjunto de dados de detalhes de custo mensal. Para obter mais informações, confira Ingerir dados de detalhes de custo. Se precisar de informações adicionais para ajudar você a tomar uma decisão para sua carga de trabalho, consulte Escolher uma solução de detalhes de custo.
Atribuir permissões a um SPN para chamar as APIs
Se você estiver procurando chamar as APIs de Exportações ou Detalhes de Custo programaticamente, será necessário configurar uma Entidade de Serviço com a permissão correta. Para obter mais informações, confira Atribuir permissões às APIs do ACM.
Evitar a API de Detalhes de Uso de Consumo da Microsoft
A API de Detalhes de Uso de Consumo é outro ponto de extremidade que dá suporte a clientes com EA. Não migre para essa API. Migre para a API de Detalhes de Custo ou de Exportações, conforme descrito anteriormente neste documento. A API de Detalhes de Uso de Consumo será preterida no futuro e está localizada atrás do ponto de extremidade a seguir.
GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/usageDetails?api-version=2021-10-01
Essa API é um ponto de extremidade síncrono e não poderá ser dimensionada conforme os gastos e o tamanho de seu conjunto de dados de custo mês após mês aumentarem. Se você estiver usando a API de Detalhes de Uso de Consumo, recomendamos migrar dela para a API de Detalhes de Custo ou de Exportações o mais rápido possível. Um anúncio formal de substituição será feito em uma data futura. Para saber mais sobre como migrar dos Detalhes de Uso de Consumo, confira Migrar da API de Detalhes de Uso de Consumo.
Benefícios da migração
Nossas novas soluções fornecem muitos benefícios em relação às APIs de Detalhes de Uso de Relatórios do EA. Segue um resumo:
- Segurança e estabilidade – novas soluções exigem a Entidade de Serviço e/ou tokens de usuário para acessar dados. Elas são mais seguras do que as chaves de API usadas para autenticação nas APIs de Relatórios do EA. As chaves nessas APIs herdadas são válidas por seis meses e poderão expor dados financeiros confidenciais se vazadas. Além disso, se as chaves não forem renovadas e integradas às cargas de trabalho antes da expiração de seis meses, o acesso a dados será revogado. Isso interrompe as cargas de trabalho do cliente.
- Escalabilidade – as APIs de Relatórios do EA não foram criadas para dimensionar bem conforme seu uso do Azure aumentar. O conjunto de dados de detalhes de uso poderá ficar grande demais à medida que você implantar mais recursos na nuvem. As novas soluções são assíncronas e têm muitos aprimoramentos de infraestrutura por trás delas para garantir downloads bem-sucedidos para conjuntos de dados de qualquer tamanho.
- 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 nas novas soluções. O conjunto de dados único reduz o número de APIs que você precisa chamar para ver todos os encargos.
- Amortização de compra – clientes que compram Reservas podem ter uma visão Amortizada de seus custos usando as novas soluções.
- Consistência de esquema – cada solução disponível fornece arquivos com campos correspondentes. Isso permite que você alterne facilmente entre soluções com base em seu cenário.
- Integração de alocação de custos – os clientes do Contrato Enterprise e do Contrato de Cliente da Microsoft podem usar a nova solução para exibir encargos em relação às regras de alocação de custos configuradas. Para obter mais informações sobre a alocação de custos, confira Alocar custos.
- Aprimoramentos futuros – as novas soluções estão sendo desenvolvidas ativamente. As soluções recebem todos os novos recursos conforme são lançadas.
APIs de Uso Empresarial para migração
A tabela a seguir resume as diferentes APIs que você pode estar usando hoje para ingerir dados de detalhes de custo. Se você estiver usando uma das seguintes APIs, precisará migrar para uma das novas soluções descritas anteriormente. Todas as APIs estão atrás do ponto de extremidade https://consumption.azure.com.
| Ponto de extremidade | Comentários da API |
|---|---|
/v3/enrollments/{enrollmentNumber}/usagedetails/download?billingPeriod={billingPeriod} |
– Método da API: GET – Síncrono (sem sondagem) – Formato de dados: CSV |
/v3/enrollments/{enrollmentNumber}/usagedetails/download?startTime=2017-01-01&endTime=2017-01-10 |
– Método da API: GET – Síncrono (sem sondagem) – Formato de dados: CSV |
/v3/enrollments/{enrollmentNumber}/usagedetails |
– Método da API: GET – Síncrono (sem sondagem) – Formato de dados: JSON |
/v3/enrollments/{enrollmentNumber}/billingPeriods/{billingPeriod}/usagedetails |
– Método da API: GET – Síncrono (sem sondagem) – Formato de dados: JSON |
/v3/enrollments/{enrollmentNumber}/usagedetailsbycustomdate?startTime=2017-01-01&endTime=2017-01-10 |
– Método da API: GET – Síncrono (sem sondagem) – Formato de dados: JSON |
/v3/enrollments/{enrollmentNumber}/usagedetails/submit?billingPeriod={billingPeriod} |
– Método da API: POST – Assíncrono (baseado em sondagem) – Formato de dados: CSV |
/v3/enrollments/{enrollmentNumber}/usagedetails/submit?startTime=2017-04-01&endTime=2017-04-10 |
– Método da API: POST – Assíncrono (baseado em sondagem) – Formato de dados: CSV |
Mapeamento de campos de dados
A tabela a seguir fornece um resumo dos campos antigos disponíveis nas soluções que você está usando no momento junto com o campo a ser usado nas novas soluções.
| Campo antigo | Novo campo | Comentários |
|---|---|---|
| accountId | ||
| accountName | AccountName | |
| accountOwnerEmail | AccountOwnerId | |
| additionalInfo | AdditionalInfo | |
| chargesBilledSeparately | isAzureCreditEligible | As propriedades são opostas. Se isAzureCreditEnabled for verdade, ChargesBilledSeparately seria falso. |
| consumedQuantity | Quantidade | |
| consumedService | ConsumedService | |
| consumedServiceId | ConsumedService | consumedServiceId fornece apenas um valor numérico.ConsumedService fornece o nome do serviço. |
| cost | CostInBillingCurrency | |
| costCenter | CostCenter | |
| data | Data | O formato no campo antigo era yyyy-mm-dd, enquanto o novo campo está no formato mm/dd/yyyy. |
| departmentId | InvoiceSectionId | |
| departmentName | InvoiceSectionName | |
| extendedCost | CostInBillingCurrency | |
| instanceId | ResourceId | |
| isRecurringCharge | Quando aplicável, use Frequency e Term fields de agora em diante. |
|
| local | ResourceLocationNormalized | |
| meterCategory | MeterCategory | |
| meterId | MeterId | |
| meterName | MeterName | |
| meterRegion | MeterRegion | |
| meterSubCategory | MeterSubCategory | |
| offerId | OfferId | |
| orderNumber | Não disponível. | |
| partNumber | PartNumber | |
| planName | PlanName | |
| produto | ProductName | |
| publisherName | PublisherName | |
| resourceGroup | ResourceGroup | |
| resourceGuid | MeterId | Os valores variam. resourceGuid é um valor de GUID. meterId é um número longo. |
| resourceLocation | ResourceLocation | |
| resourceLocationId | Não disponível. | |
| resourceRate | EffectivePrice | |
| serviceInfo1 | ServiceInfo1 | |
| serviceInfo2 | ServiceInfo2 | |
| serviceName | MeterCategory | |
| serviceTier | MeterSubCategory | |
| storeServiceIdentifier | Não disponível. | |
| subscriptionGuid | SubscriptionId | |
| subscriptionId | SubscriptionId | |
| subscriptionName | SubscriptionName | |
| marcas | Marcações | O novo campo não tem {} envolvente ao redor dos pares chave-valor. |
| unitOfMeasure | UnitOfMeasure |