Reservations Details - List

Référence

Service:: Consumption

Version d'API:: 2024-08-01

Répertorie les détails des réservations pour la plage de dates fournie. 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. Si la taille des données est trop importante, les clients peuvent également obtenir 504 lorsque l’API a expiré pour préparer les données. Dans ce cas, l’appel d’API doit être effectué avec des plages de dates plus petites ou un appel à l’API Générer des détails de réservation doit être effectué, car il est asynchrone et ne s’exécute pas dans les délais d’expiration de la taille de réponse.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceScope	path	True	string	Étendue associée aux opérations de détails des réservations. Cela inclut « /providers/Microsoft.Billing/billingAccounts/{billingAccountId} » pour l’étendue BillingAccount (hérité) et « /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} » pour l’étendue BillingProfile (moderne).
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente. La version actuelle est 2023-03-01.
$filter	query		string	Filtrez les détails de la réservation par plage de dates. Propriétés/UsageDate pour la date de début et la date de fin. Le filtre prend en charge « le » et « ge ». Non applicable lors de l’interrogation avec le profil de facturation
endDate	query		string	Date de fin. Applicable uniquement lors de l’interrogation avec le profil de facturation
reservationId	query		string	GUID de l’ID de réservation. Valide uniquement si reservationOrderId est également fourni. Filtrer sur une réservation spécifique
reservationOrderId	query		string	GUID de l’ID de commande de réservation. Obligatoire si reservationId est fourni. Filtrer dans un ordre de réservation spécifique
startDate	query		string	Date de début. Applicable uniquement lors de l’interrogation avec le profil de facturation

Réponses

Nom	Type	Description
200 OK	ReservationDetailsListResult	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

ReservationDetailsByBillingAccountId

ReservationDetailsByBillingProfileId

ReservationDetailsByBillingProfileIdReservationId

ReservationDetailsByBillingAccountId

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "usageDate": "2017-11-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

ReservationDetailsByBillingProfileId

Exemple de requête

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails?startDate=2019-09-01&endDate=2019-10-31&api-version=2024-08-01

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationId": "00000000-0000-0000-0000-000000000000",
        "usageDate": "2019-09-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

ReservationDetailsByBillingProfileIdReservationId

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1",
      "name": "reservationDetails_Id1",
      "type": "Microsoft.Consumption/reservationDetails",
      "tags": null,
      "properties": {
        "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc",
        "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b",
        "usageDate": "2019-09-30T00:00:00-08:00",
        "skuName": "Standard_D2s_v3",
        "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1",
        "totalReservedQuantity": 0,
        "reservedHours": 48,
        "usedHours": 0.6,
        "instanceFlexibilityGroup": "DSv3 Series",
        "instanceFlexibilityRatio": "1"
      }
    }
  ]
}

Définitions

Nom	Description
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.
ReservationDetail	ressource de détails de réservation.
ReservationDetailsListResult	Résultat de la liste des détails de la réservation.

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.

ReservationDetail

Object

ressource de détails 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.instanceFlexibilityGroup	string	Groupe de flexibilité d’instance.
properties.instanceFlexibilityRatio	string	Taux de flexibilité de l’instance.
properties.instanceId	string	Cet identificateur est le nom de la ressource ou de l’ID de ressource complet.
properties.kind	string	Type 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 pour la journée. 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 de 24 heures à partir 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)	Date à laquelle la consommation s’est produite.
properties.usedHours	number (decimal)	Il s’agit des heures totales utilisées par l’instance.
tags	object	Balises de ressource.
type	string	Type de ressource.

ReservationDetailsListResult

Object

Résultat de la liste des détails de la réservation.

Nom	Type	Description
nextLink	string	Lien (URL) vers la page suivante des résultats.
value	ReservationDetail[]	Liste des détails de la réservation.

Partager via

Reservations Details - List

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

ReservationDetailsByBillingAccountId

Exemple de requête

Exemple de réponse

ReservationDetailsByBillingProfileId

Exemple de requête

Exemple de réponse

ReservationDetailsByBillingProfileIdReservationId

Exemple de requête

Exemple de réponse

Définitions

ErrorDetails

ErrorResponse

ReservationDetail

ReservationDetailsListResult