Compartilhar via

Migrar da API de Detalhes de Uso da Instância Reservada do EA

  • Artigo

Os clientes de EA que anteriormente usavam a API dos Relatórios do Enterprise consumption.azure.com para obter detalhes de uso de instância reservada precisam migrar para uma API de paridade do Azure Resource Manager. As instruções a seguir ajudam você a migrar e discutir quaisquer diferenças contratuais entre a API antiga e a nova API.

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.

Atribuir permissões a uma entidade de serviço para chamar a API

Antes de chamar a API, você precisa configurar uma Entidade de Serviço com a permissão correta. Use a entidade de serviço para chamar a API. Para obter mais informações, consulte Atribuir permissões às APIs de Gerenciamento de Custos.

Chamada à API de Detalhes de Uso da Instância Reservada

A Microsoft não está atualizando as APIs de Detalhes de Reserva baseada em configurações síncronas mais antigas. Recomendamos que você mude para o padrão de chamada à API assíncrona com suporte do SPN mais recente como parte da migração. As solicitações assíncronas lidam melhor com grandes quantidades de dados e reduzem os erros de tempo limite.

Solicitações com suporte

Use os URIs de solicitação a seguir quando chamar a nova API de Detalhes de Reserva Assíncrona. O número de registro deve ser usado como billingAccountId. Você pode chamar a API com o seguinte escopo:

Registro: providers/Microsoft.Billing/billingAccounts/{billingAccountId}

Gerar relatório por ID da conta de cobrança

Exemplo de solicitação para gerar um relatório de detalhes de reserva

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport?startDate={startDate}&endDate={endDate}&api-version=2023-11-01

A solicitação POST retorna um local para sondar o status de geração de relatório, conforme descrito na seguinte resposta:

Resposta de exemplo

Código de status = 202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb?api-version=2023-11-01
Retry-After: 60

Código de status = 200

{
  "status": "Completed",
  "properties": {
    "reportUrl": "https://storage.blob.core.windows.net/details/20200911/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2020-09-12T02:56:55.5021869Z"
  }
}

Exemplo de solicitação para sondar o status de geração de relatório

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/reservationDetailsOperationResults/{operationId}?api-version=2023-11-01

Resposta de sondagem de exemplo

{
  "status": "Completed",
  "properties": {
    "reportUrl": "https://storage.blob.core.windows.net/details/20200911/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2020-09-12T02:56:55.5021869Z"
  }
}

Alterações do corpo da resposta

As informações a seguir são um exemplo da resposta da API de Detalhes da Reserva com base em síncrona mais antiga.

Resposta antiga:

{
    "reservationOrderId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "reservationId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
    "usageDate": "2018-02-01T00:00:00",
    "skuName": "Standard_F2s",
    "instanceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/resourcegroup1/providers/microsoft.compute/virtualmachines/VM1",
    "totalReservedQuantity": 18.000000000000000,
    "reservedHours": 432.000000000000000,
    "usedHours": 400.000000000000000
}

Resposta nova:

A nova API cria um arquivo CSV para você. Confira os campos de arquivo a seguir.

Propriedade antiga Nova propriedade Observações
InstanceFlexibilityGroup A nova propriedade de flexibilidade de tamanho da instância.
InstanceFlexibilityRatio A nova propriedade de flexibilidade de tamanho da instância.
instanceId InstanceName
Tipo É uma nova propriedade. O valor é None, Reservation ou IncludedQuantity.
reservationId ReservationId
reservationOrderId ReservationOrderId
reservedHours ReservedHours
skuName SkuName
totalReservedQuantity TotalReservedQuantity
usageDate UsageDate
usedHours UsedHours

Conteúdo relacionado