Reservations Summaries - List

Referência

Serviço:: Consumption

Versão da API:: 2024-08-01

Lista os resumos de reservas para o escopo definido diariamente ou mensalmente. Observação: o ARM tem um limite de tamanho de carga de 12 MB, portanto, atualmente, os chamadores recebem 400 quando o tamanho da resposta excede o limite do ARM. Nesses casos, a chamada à API deve ser feita com intervalos de datas menores.

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&api-version=2024-08-01

Com parâmetros opcionais:

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&startDate={startDate}&endDate={endDate}&$filter={$filter}&reservationId={reservationId}&reservationOrderId={reservationOrderId}&api-version=2024-08-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceScope	path	True	string	O escopo associado às operações de resumo de reservas. Isso inclui '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para o escopo BillingAccount (herdado) e '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo BillingProfile (moderno).
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2023-03-01.
grain	query	True	datagrain	Pode ser diário ou mensal
$filter	query		string	Necessário apenas para grãos diários. As propriedades/UsageDate para data de início e data de término. O filtro dá suporte a 'le' e 'ge'. Não aplicável ao consultar com o perfil de cobrança
endDate	query		string	Data de término. Aplicável somente ao consultar com o perfil de cobrança
reservationId	query		string	GUID de ID de reserva. Válido somente se reservationOrderId também for fornecido. Filtrar para uma reserva específica
reservationOrderId	query		string	GUID da ID do Pedido de Reserva. Obrigatório se reservationId for fornecido. Filtrar para uma ordem de reserva específica
startDate	query		string	Data de início. Aplicável somente ao consultar com o perfil de cobrança

Respostas

Nome	Tipo	Description
200 OK	ReservationSummariesListResult	OKEY. A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ReservationSummariesDailyWithBillingAccountId

ReservationSummariesDailyWithBillingProfileId

ReservationSummariesMonthlyWithBillingAccountId

ReservationSummariesMonthlyWithBillingProfileId

ReservationSummariesMonthlyWithBillingProfileIdReservationId

ReservationSummariesDailyWithBillingAccountId

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries?grain=daily&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-11-20&api-version=2024-08-01

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_B1s",
        "reservedHours": 720,
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0
      }
    }
  ]
}

ReservationSummariesDailyWithBillingProfileId

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?grain=daily&startDate=2017-10-01&endDate=2017-11-20&api-version=2024-08-01

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_B1s",
        "reservedHours": 720,
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithBillingAccountId

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&api-version=2024-08-01

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_B1s",
        "reservedHours": 720,
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithBillingProfileId

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&api-version=2024-08-01

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_B1s",
        "reservedHours": 720,
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithBillingProfileIdReservationId

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&reservationId=1c6b6358-709f-484c-85f1-72e862a0cf3b&reservationOrderId=9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc&api-version=2024-08-01

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1",
      "name": "reservationSummaries_Id1",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": null,
      "properties": {
        "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc",
        "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
        "skuName": "Standard_B1s",
        "reservedHours": 720,
        "usageDate": "2018-09-01T00:00:00-07:00",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0
      }
    }
  ]
}

Definições

Nome	Description
datagrain	Pode ser diário ou mensal
ErrorDetails	Os detalhes do erro.
ErrorResponse	A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro. Algumas respostas de erro: 429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After". Tempo limite do Gateway 504 – Tempo limite de serviço atingido durante o processamento da solicitação. Reduza o intervalo de datas na solicitação, se possível.
ReservationSummariesListResult	Resultado da listagem de resumos de reserva.
ReservationSummary	recurso de resumo de reserva.

datagrain

Enumeração

Pode ser diário ou mensal

Valor	Description
daily	Grão diário de dados
monthly	Grão mensal de dados

ErrorDetails

Objeto

Os detalhes do erro.

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponse

Objeto

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".
Tempo limite do Gateway 504 – Tempo limite de serviço atingido durante o processamento da solicitação. Reduza o intervalo de datas na solicitação, se possível.

Nome	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

ReservationSummariesListResult

Objeto

Resultado da listagem de resumos de reserva.

Nome	Tipo	Description
nextLink	string	O link (url) para a próxima página de resultados.
value	ReservationSummary[]	A lista de resumos de reserva.

ReservationSummary

Objeto

recurso de resumo de reserva.

Nome	Tipo	Description
etag	string	A etag do recurso.
id	string	A ID do ARM totalmente qualificada de um evento.
name	string	A ID que identifica exclusivamente um evento.
properties.avgUtilizationPercentage	number (decimal)	Essa é a utilização média para todo o intervalo de tempo. (dia ou mês, dependendo do grão)
properties.kind	string	O tipo de reserva.
properties.maxUtilizationPercentage	number (decimal)	Essa é a utilização máxima por hora na hora de uso (dia ou mês). Por exemplo, se o registro de uso corresponder a 10/12/2017 e, nesse caso, para as horas 4 e 5, a utilização for de 100%, esse campo retornará 100% para esse dia.
properties.minUtilizationPercentage	number (decimal)	Essa é a utilização mínima por hora na hora de uso (dia ou mês). Por exemplo, se o registro de uso corresponder a 10/12/2017 e, na hora 4 e 5, a utilização for de 10%, esse campo retornará 10% para esse dia
properties.purchasedQuantity	number (decimal)	Essa é a quantidade adquirida para a reservationId.
properties.remainingQuantity	number (decimal)	Essa é a quantidade restante para a reservationId.
properties.reservationId	string	A ID da reserva é o identificador de uma reserva em uma ordem 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.
properties.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. A ordem de reserva especifica o tamanho e a região da VM para as reservas.
properties.reservedHours	number (decimal)	Esse é o total de horas reservadas. Por exemplo, se a reserva para 1 instância foi feita às 13h, serão 11 horas para esse dia e 24 horas a partir dos dias seguintes
properties.skuName	string	Este é o nome do ARM Sku. Ele pode ser usado para ingressar no campo serviceType em informações adicionais nos registros de uso.
properties.totalReservedQuantity	number (decimal)	Essa é a contagem total de instâncias reservadas para a reservationId.
properties.usageDate	string (date-time)	Dados correspondentes ao registro de utilização. Se a granulação de dados for mensal, será o primeiro dia do mês.
properties.usedHours	number (decimal)	Total de horas usadas pela reserva
properties.usedQuantity	number (decimal)	Essa é a quantidade usada para a reservationId.
properties.utilizedPercentage	number (decimal)	Esse é o percentual utilizado para a ID da reserva.
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

Compartilhar via

Reservations Summaries - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ReservationSummariesDailyWithBillingAccountId

Solicitação de exemplo

Resposta de exemplo

ReservationSummariesDailyWithBillingProfileId

Solicitação de exemplo

Resposta de exemplo

ReservationSummariesMonthlyWithBillingAccountId

Solicitação de exemplo

Resposta de exemplo

ReservationSummariesMonthlyWithBillingProfileId

Solicitação de exemplo

Resposta de exemplo

ReservationSummariesMonthlyWithBillingProfileIdReservationId

Solicitação de exemplo

Resposta de exemplo

Definições

datagrain

ErrorDetails

ErrorResponse

ReservationSummariesListResult

ReservationSummary