Partager via

Reservations Summaries - List By Reservation Order And Reservation

  • Référence
Service:
Consumption
Version d'API:
2024-08-01

Répertorie les résumés des réservations pour les grains quotidiens ou mensuels. Remarque : ARM a une limite de taille de charge utile de 12 Mo. Les appelants obtiennent donc 400 lorsque la taille de réponse dépasse la limite ARM. Dans ce cas, l’appel d’API doit être effectué avec des plages de dates plus petites.

GET https://management.azure.com/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries?grain={grain}&api-version=2024-08-01
Avec des paramètres facultatifs: 
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

Paramètres URI

Nom Dans Obligatoire Type Description
reservationId
 path True

string

ID de la réservation
reservationOrderId
 path True

string

ID de commande de la réservation
api-version
 query True

string

Version de l’API à utiliser avec la demande cliente. La version actuelle est 2023-03-01.
grain
 query True

datagrain

Peut être quotidien ou mensuel
$filter
 query

string

Obligatoire uniquement pour le grain quotidien. Propriétés/UsageDate pour la date de début et la date de fin. Le filtre prend en charge 'le' et 'ge'

Réponses

Nom Type Description
200 OK

ReservationSummariesListResult

D’ACCORD. La demande a réussi.
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ReservationSummariesDailyWithReservationId
ReservationSummariesMonthlyWithReservationId

ReservationSummariesDailyWithReservationId

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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
      }
    }
  ]
}

Définitions

Nom Description
datagrain

Peut être quotidien ou mensuel
ErrorDetails

Détails de l’erreur.
ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Réponses d’erreur :

  • 429 TooManyRequests : la requête est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ».

  • 503 ServiceUnavailable - Le service est temporairement indisponible. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « Retry-After ».

  • 504 Délai d’expiration de la passerelle : le service a expiré lors du traitement de la demande. Réduisez la plage de dates dans la requête, si possible.
ReservationSummariesListResult

Résultat de la liste des résumés de réservation.
ReservationSummary

ressource récapitulative de réservation.

datagrain

Énumération

Peut être quotidien ou mensuel

Valeur Description
daily

Grain quotidien des données
monthly

Grain mensuel des données

ErrorDetails

Object

Détails de l’erreur.

Nom Type Description
code

string

Code d’erreur.
message

string

Message d’erreur indiquant pourquoi l’opération a échoué.

ErrorResponse

Object

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Réponses d’erreur :

  • 429 TooManyRequests : la requête est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ».

  • 503 ServiceUnavailable - Le service est temporairement indisponible. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « Retry-After ».

  • 504 Délai d’expiration de la passerelle : le service a expiré lors du traitement de la demande. Réduisez la plage de dates dans la requête, si possible.

Nom Type Description
error

ErrorDetails

Détails de l’erreur.

ReservationSummariesListResult

Object

Résultat de la liste des résumés de réservation.

Nom Type Description
nextLink

string

Lien (URL) vers la page suivante des résultats.
value

ReservationSummary[]

Liste des résumés de réservation.

ReservationSummary

Object

ressource récapitulative de réservation.

Nom Type Description
etag

string

Etag de la ressource.
id

string

ID ARM complet d’un événement.
name

string

ID qui identifie de façon unique un événement.
properties.avgUtilizationPercentage

number (decimal)

Il s’agit de l’utilisation moyenne pour l’intervalle de temps entier. (jour ou mois en fonction du grain)
properties.kind

string

Type de réservation.
properties.maxUtilizationPercentage

number (decimal)

Il s’agit de l’utilisation horaire maximale dans l’heure d’utilisation (jour ou mois). Par exemple, si l’enregistrement d’utilisation correspond à 12/10/2017 et que pour l’heure 4 et 5, l’utilisation était de 100%, ce champ retourne 100% pour ce jour.
properties.minUtilizationPercentage

number (decimal)

Il s’agit de l’utilisation horaire minimale dans l’heure d’utilisation (jour ou mois). Par exemple, si l’enregistrement d’utilisation correspond à 12/10/2017 et que, pour l’heure 4 et 5, l’utilisation était de 10%, ce champ retourne 10% pour ce jour-là
properties.purchasedQuantity

number (decimal)

Il s’agit de la quantité achetée pour l’ID de réservation.
properties.remainingQuantity

number (decimal)

Il s’agit de la quantité restante pour l’ID de réservation.
properties.reservationId

string

L’ID de réservation est l’identificateur d’une réservation dans un ordre de réservation. Chaque réservation est le regroupement pour appliquer l’étendue de l’avantage et spécifie également le nombre d’instances auxquelles l’avantage de réservation peut être appliqué.
properties.reservationOrderId

string

L’ID de la commande de réservation est l’identificateur d’un achat de réservation. Chaque ID de commande de réservation représente une transaction d’achat unique. Un ordre de réservation contient des réservations. L’ordre de réservation spécifie la taille et la région de la machine virtuelle pour les réservations.
properties.reservedHours

number (decimal)

Il s’agit du nombre total d’heures réservées. Par exemple, si la réservation pour 1 instance a été effectuée le 1er h, elle sera de 11 heures pour ce jour et 24 heures des jours suivants
properties.skuName

string

Il s’agit du nom de la référence SKU ARM. Il peut être utilisé pour joindre le champ serviceType dans des informations supplémentaires dans les enregistrements d’utilisation.
properties.totalReservedQuantity

number (decimal)

Il s’agit du nombre total d’instances réservées à l’ID de réservation.
properties.usageDate

string (date-time)

Données correspondant à l’enregistrement d’utilisation. Si le grain de données est mensuel, il s’agit du premier jour du mois.
properties.usedHours

number (decimal)

Nombre total d’heures utilisées par la réservation
properties.usedQuantity

number (decimal)

Il s’agit de la quantité utilisée pour l’ID de réservation.
properties.utilizedPercentage

number (decimal)

Il s’agit du pourcentage utilisé pour l’ID de réservation.
tags

object

Balises de ressource.
type

string

Type de ressource.