Reservations Details - List

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?api-version=2024-08-01&startDate={startDate}&endDate={endDate}&$filter={$filter}&reservationId={reservationId}&reservationOrderId={reservationOrderId}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceScope	path	True	string	Identificateur Azure Resource Manager complet de la ressource.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
$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	La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

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?api-version=2024-08-01&$filter=properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-12-05

Go

package armconsumption_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption/v2"
)

// Generated from example definition: 2024-08-01/ReservationDetailsByBillingAccountId.json
func ExampleReservationsDetailsClient_NewListPager_reservationDetailsByBillingAccountId() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armconsumption.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReservationsDetailsClient().NewListPager("providers/Microsoft.Billing/billingAccounts/12345", &armconsumption.ReservationsDetailsClientListOptions{
		Filter: to.Ptr("properties/usageDate ge 2017-10-01 AND properties/usageDate le 2017-12-05")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armconsumption.ReservationsDetailsClientListResponse{
		// 	ReservationDetailsListResult: armconsumption.ReservationDetailsListResult{
		// 		Value: []*armconsumption.ReservationDetail{
		// 			{
		// 				Name: to.Ptr("reservationDetails_Id1"),
		// 				Type: to.Ptr("Microsoft.Consumption/reservationDetails"),
		// 				ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1"),
		// 				Properties: &armconsumption.ReservationDetailProperties{
		// 					InstanceFlexibilityGroup: to.Ptr("DSv3 Series"),
		// 					InstanceFlexibilityRatio: to.Ptr("1"),
		// 					InstanceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1"),
		// 					ReservationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					ReservationOrderID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					SKUName: to.Ptr("Standard_D2s_v3"),
		// 					UsageDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-30T00:00:00-08:00"); return t}()),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

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

ReservationDetailsByBillingProfileId

Exemple de requête

HTTP

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

Go

package armconsumption_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption/v2"
)

// Generated from example definition: 2024-08-01/ReservationDetailsByBillingProfileId.json
func ExampleReservationsDetailsClient_NewListPager_reservationDetailsByBillingProfileId() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armconsumption.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReservationsDetailsClient().NewListPager("providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", &armconsumption.ReservationsDetailsClientListOptions{
		EndDate:   to.Ptr("2019-10-31"),
		StartDate: to.Ptr("2019-09-01")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armconsumption.ReservationsDetailsClientListResponse{
		// 	ReservationDetailsListResult: armconsumption.ReservationDetailsListResult{
		// 		Value: []*armconsumption.ReservationDetail{
		// 			{
		// 				Name: to.Ptr("reservationDetails_Id1"),
		// 				Type: to.Ptr("Microsoft.Consumption/reservationDetails"),
		// 				ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1"),
		// 				Properties: &armconsumption.ReservationDetailProperties{
		// 					InstanceFlexibilityGroup: to.Ptr("DSv3 Series"),
		// 					InstanceFlexibilityRatio: to.Ptr("1"),
		// 					InstanceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1"),
		// 					ReservationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					ReservationOrderID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 					SKUName: to.Ptr("Standard_D2s_v3"),
		// 					UsageDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-09-30T00:00:00-08:00"); return t}()),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

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

ReservationDetailsByBillingProfileIdReservationId

Exemple de requête

HTTP

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

Go

package armconsumption_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption/v2"
)

// Generated from example definition: 2024-08-01/ReservationDetailsByBillingProfileIdReservationId.json
func ExampleReservationsDetailsClient_NewListPager_reservationDetailsByBillingProfileIdReservationId() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armconsumption.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReservationsDetailsClient().NewListPager("providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", &armconsumption.ReservationsDetailsClientListOptions{
		EndDate:            to.Ptr("2019-10-31"),
		ReservationID:      to.Ptr("1c6b6358-709f-484c-85f1-72e862a0cf3b"),
		ReservationOrderID: to.Ptr("9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc"),
		StartDate:          to.Ptr("2019-09-01")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armconsumption.ReservationsDetailsClientListResponse{
		// 	ReservationDetailsListResult: armconsumption.ReservationDetailsListResult{
		// 		Value: []*armconsumption.ReservationDetail{
		// 			{
		// 				Name: to.Ptr("reservationDetails_Id1"),
		// 				Type: to.Ptr("Microsoft.Consumption/reservationDetails"),
		// 				ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1"),
		// 				Properties: &armconsumption.ReservationDetailProperties{
		// 					InstanceFlexibilityGroup: to.Ptr("DSv3 Series"),
		// 					InstanceFlexibilityRatio: to.Ptr("1"),
		// 					InstanceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1"),
		// 					ReservationID: to.Ptr("1c6b6358-709f-484c-85f1-72e862a0cf3b"),
		// 					ReservationOrderID: to.Ptr("9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc"),
		// 					SKUName: to.Ptr("Standard_D2s_v3"),
		// 					UsageDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-09-30T00:00:00-08:00"); return t}()),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ReservationDetail	ressource de détails de réservation.
ReservationDetailsListResult	Résultat de la liste des détails de la réservation.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ReservationDetail

Objet

ressource de détails de réservation.

Nom	Type	Description
etag	string	Etag de la ressource.
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
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.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ReservationDetailsListResult

Objet

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.

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.