Reservations Summaries - List By Reservation Order And Reservation

Referencia

Servicio:: Consumption

Versión de la API:: 2024-08-01

Enumera los resúmenes de reservas para el grano diario o mensual. Nota: ARM tiene un límite de tamaño de carga de 12 MB, por lo que los autores de llamadas actualmente obtienen 400 cuando el tamaño de respuesta supera el límite de ARM. En tales casos, se debe realizar una llamada API con intervalos de fechas más pequeños.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
reservationId	path	True	string	Identificador de la reserva
reservationOrderId	path	True	string	Id. de pedido de la reserva
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2023-03-01.
grain	query	True	datagrain	Puede ser diaria o mensual.
$filter	query		string	Solo se requiere para el grano diario. Propiedades/UsageDate para fecha de inicio y fecha de finalización. El filtro admite 'le' y 'ge'

Respuestas

Nombre	Tipo	Description
200 OK	ReservationSummariesListResult	De acuerdo. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ReservationSummariesDailyWithReservationId

ReservationSummariesMonthlyWithReservationId

ReservationSummariesDailyWithReservationId

Solicitud de ejemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_D8s_v3",
        "kind": "Reservation",
        "reservedHours": 0,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "totalReservedQuantity": 155,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      }
    }
  ]
}

ReservationSummariesMonthlyWithReservationId

Solicitud de ejemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries?grain=monthly&api-version=2024-08-01

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001",
      "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001",
      "type": "Microsoft.Consumption/reservationSummaries",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "skuName": "Standard_D8s_v3",
        "kind": "Reservation",
        "reservedHours": 0,
        "usageDate": "2017-10-01T00:00:00Z",
        "usedHours": 0,
        "minUtilizationPercentage": 0,
        "avgUtilizationPercentage": 0,
        "maxUtilizationPercentage": 0,
        "purchasedQuantity": 0,
        "remainingQuantity": 0,
        "totalReservedQuantity": 155,
        "usedQuantity": 0,
        "utilizedPercentage": 0
      }
    }
  ]
}

Definiciones

Nombre	Description
datagrain	Puede ser diaria o mensual.
ErrorDetails	Detalles del error.
ErrorResponse	La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. Algunas respuestas de error: 429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After". Tiempo de espera de puerta de enlace 504: se agota el tiempo de espera del servicio mientras se procesa la solicitud. Reduzca el intervalo de fechas de la solicitud, si es posible.
ReservationSummariesListResult	Resultado de los resúmenes de la reserva de lista.
ReservationSummary	recurso de resumen de reserva.

datagrain

Enumeración

Puede ser diaria o mensual.

Valor	Description
daily	Detalle diario de los datos
monthly	Detalle mensual de los datos

ErrorDetails

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

ErrorResponse

Object

La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Algunas respuestas de error:

429 TooManyRequests: la solicitud está limitada. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable: el servicio no está disponible temporalmente. Vuelva a intentarlo después de esperar el tiempo especificado en el encabezado "Retry-After".
Tiempo de espera de puerta de enlace 504: se agota el tiempo de espera del servicio mientras se procesa la solicitud. Reduzca el intervalo de fechas de la solicitud, si es posible.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error.

ReservationSummariesListResult

Object

Resultado de los resúmenes de la reserva de lista.

Nombre	Tipo	Description
nextLink	string	Vínculo (url) a la página siguiente de resultados.
value	ReservationSummary[]	Lista de resúmenes de reserva.

ReservationSummary

Object

recurso de resumen de reserva.

Nombre	Tipo	Description
etag	string	El valor de etag del recurso.
id	string	Identificador completo de ARM de un evento.
name	string	Identificador que identifica de forma única un evento.
properties.avgUtilizationPercentage	number (decimal)	Se trata del uso medio para todo el intervalo de tiempo. (día o mes en función del grano)
properties.kind	string	Tipo de reserva.
properties.maxUtilizationPercentage	number (decimal)	Este es el uso máximo por hora en el tiempo de uso (día o mes). Por ejemplo, si el registro de uso corresponde al 12/10/2017 y en ese caso durante la hora 4 y 5, el uso era de 100%, este campo devolverá 100% para ese día.
properties.minUtilizationPercentage	number (decimal)	Este es el uso mínimo por hora en el tiempo de uso (día o mes). Por ejemplo, si el registro de uso corresponde al 12/10/2017 y en ese caso durante la hora 4 y 5, el uso era de 10%, este campo devolverá 10% para ese día
properties.purchasedQuantity	number (decimal)	Esta es la cantidad comprada para el valor de reservationId.
properties.remainingQuantity	number (decimal)	Esta es la cantidad restante para el valor de reservationId.
properties.reservationId	string	El identificador de reserva es el identificador de una reserva dentro de un pedido de reserva. Cada reserva es la agrupación para aplicar el ámbito de la ventaja y también especifica el número de instancias a las que se puede aplicar la ventaja de reserva.
properties.reservationOrderId	string	El identificador del pedido de reserva es el identificador de una compra de reserva. Cada identificador de pedido de reserva representa una única transacción de compra. Un pedido de reserva contiene reservas. El pedido de reserva especifica el tamaño y la región de la máquina virtual para las reservas.
properties.reservedHours	number (decimal)	Se trata del total de horas reservadas. Por ejemplo, si la reserva de 1 instancia se realizó a las 1 p. m., esta será de 11 horas para ese día y 24 horas a partir de los días posteriores
properties.skuName	string	Este es el nombre de Sku de ARM. Se puede usar para unirse con el campo serviceType en información adicional en los registros de uso.
properties.totalReservedQuantity	number (decimal)	Este es el recuento total de instancias reservadas para el valor de reservationId.
properties.usageDate	string (date-time)	Datos correspondientes al registro de uso. Si el detalle de los datos es mensual, será el primer día del mes.
properties.usedHours	number (decimal)	Total de horas usadas por la reserva
properties.usedQuantity	number (decimal)	Esta es la cantidad usada para el valor de reservationId.
properties.utilizedPercentage	number (decimal)	Este es el porcentaje utilizado para el identificador de reserva.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

Compartir a través de

Reservations Summaries - List By Reservation Order And Reservation

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ReservationSummariesDailyWithReservationId

Solicitud de ejemplo

Respuesta de muestra

ReservationSummariesMonthlyWithReservationId

Solicitud de ejemplo

Respuesta de muestra

Definiciones

datagrain

ErrorDetails

ErrorResponse

ReservationSummariesListResult

ReservationSummary

Recursos adicionales