Obter o uso da Instância Reservada para clientes corporativos

Artigo
02/28/2024

Observação

Em 1º de maio de 2024, as APIs do Azure Enterprise Reporting serão desativadas. Todas as APIs de Relatórios Corporativos restantes deixarão de responder às solicitações. Os clientes precisam fazer a transição para usar as APIs de Gerenciamento de Custos da Microsoft antes disso. Para saber mais, confira Migrar do Azure Enterprise Reporting para a visão geral das APIs de Gerenciamento de Custos da Microsoft.

A API de Uso da Instância Reservada retorna o uso das compras da Instância Reservada em um registro. Se houver mais de uma Instância Reservada em um registro, você poderá obter o uso de todas as compras de Instância Reservada usando essa API.

Solicitação dos detalhes de uso da Instância Reservada

Consulte o artigo Visão geral das APIs de relatórios para clientes Enterprise para saber mais sobre as propriedades de cabeçalho comuns necessárias.

Método	URI da solicitação
GET	`https://consumption.azure.com/v2/enrollments/{enrollmentNumber}/reservationdetails?startDate={yyyy-mm-dd}&endDate={yyyy-mm-dd}`

Resposta de detalhes de uso

[{
    "reservationOrderId": "00000000-0000-0000-0000-000000000000",
    "reservationId": "00000000-0000-0000-0000-000000000000",
    "usageDate": "2018-02-01T00:00:00",
    "skuName": "Standard_F2s",
    "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourvegroup1/providers/microsoft.compute/virtualmachines/VM1",
    "totalReservedQuantity": 18.000000000000000,
    "reservedHours": 432.000000000000000,
    "usedHours": 400.000000000000000
}

Definições da propriedade de resposta

Nome da propriedade	Tipo	Descrição
reservationOrderId	string	A ID do pedido de reserva é o identificador de uma compra de reserva. Cada ID de pedido de reserva representa uma única transação de compra. Um pedido de reserva contém reservas. O pedido de reserva especifica o tamanho e a região da VM para as reservas.
reservationId	string	A ID de reserva é o identificador de uma reserva dentro de um pedido de reserva. Cada reserva é o agrupamento para aplicar o escopo do benefício e também especifica o número de instâncias às quais o benefício de reserva pode ser aplicado.
usageDate	string	A data em que ocorreu o consumo.
skuName	string	Esse é o nome do Sku do Resource Manager do Azure. Ele pode ser usado para ingressar com o campo servicetype em additionalInfo em registros de uso.
instanceId	string	Esse identificador é o nome do recurso ou a ID do recurso totalmente qualificado.
totalReservedQuantity	string	Essa é a contagem total de instâncias reservadas para a ID de reserva.
reservedHours	decimal	Esse é o total de horas reservadas para o dia. Por exemplo, se a reserva para uma instância tiver sido feita às 13h, o horário reservado será de 11 horas para o primeiro dia e 24 horas para os dias subsequentes.
usedHours	decimal	Esse é o total de horas usadas pela instância.

Solicitação de resumo de uso da Instância Reservada

Consulte o artigo Visão geral das APIs de relatórios para clientes Enterprise para saber mais sobre as propriedades de cabeçalho comuns necessárias. A API dá suporte à utilização de reserva para granularidade diária e mensal. Os parâmetros Startdate e EndDate não são necessários para dados mensais.

Método	URI da solicitação
GET	`https://consumption.azure.com/v2/enrollments/{enrollmentNumber}/reservationsummaries?grain=daily&startdate={yyyy-mm-dd}&enddate={yyyy-mm-dd}`

Resposta de resumo de uso

[
     {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_F1s",
        "reservedHours": 24,
        "usageDate": "2018-05-01T00:00:00",
        "usedHours": 23,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 95.83,
        "maxUtilizationPercentage": 100
    }
]