Vue d’ensemble des API de création de rapports Azure Enterprise

  • Article

Remarque

Toutes les API Azure Enterprise Reporting sont supprimées. Vous devez migrer vers les API Microsoft Cost Management dès que possible.

Les API de création de rapports Azure Enterprise permettent aux clients Azure Enterprise d’extraire leurs données de consommation et de facturation par programme pour les transférer vers les outils d’analyse de données de leur choix. Les clients d’entreprise ont signé un Accord Entreprise (EA) auprès d’Azure pour négocier le paiement anticipé Azure (précédemment appelé engagement monétaire) et accéder à la tarification personnalisée pour les ressources Azure.

Tous les paramètres de date et d’heure nécessaires aux API doivent être représentés sous forme de valeurs UTC (temps universel coordonné) combinées. Les valeurs retournées par les API s’affichent au format UTC.

Autoriser l’API à accéder aux données

  • Générez ou récupérez la clé API : pour plus d’informations, consultez génération de clé API.
  • Transmission des clés dans l’API : vous devez transmettre la clé API pour chaque appel à des fins d’authentification et d’autorisation. La propriété suivante doit être aux en-têtes HTTP.
Clé d’en-tête de demande Valeur
Autorisation Indiquez la valeur dans ce format : porteur {API_CLÉ}
Exemple : porteur eyr... 09

API basées sur la consommation

Un point de terminaison Swagger est disponible ici pour les API suivantes. Ils doivent permettre une introspection simple de l’API et la possibilité de générer des kits de développement logiciel client (SDK) à l’aide d’AutoRest ou Swagger CodeGen. À compter du 1er mai 2014, ces données sont disponibles via cette API.

  • Solde et résumé : l’API Balance and Summary propose un résumé mensuel des informations sur les soldes, les nouveaux achats, les frais de service Place de marché Azure, les ajustements et les frais de dépassement.

  • Usage Details (Détails d’utilisation) : l’API Usage Details offre une analyse quotidienne des quantités consommées et des frais estimés pour un abonnement. Le résultat inclut également des informations sur les instances, les compteurs et les services. Interrogez l’API par période de facturation ou par date de début et de fin spécifiée.

  • Frais du Magasin de la Place de marché : l’API Frais du Store de la Place de marché retourne la répartition des frais de la Place de marché par jour pour la période de facturation ou les dates de début et de fin spécifiées (les frais d’utilisation ne sont pas inclus).

  • Price Sheet (Grille tarifaire) : l’API Price Sheet fournit les tarifs applicables pour chaque compteur selon l’abonnement et la période de facturation donnés.

  • Informations détaillées sur les instances réservées - L'API Utilisation des instances réservées renvoie l'utilisation des instances réservées achetées. L'API Frais des instances réservées affiche les transactions de facturation effectuées.

Actualisation des données

Les etags sont retournés dans la réponse de l’API ci-dessus. Une modification dans Etag indique que les données ont été actualisées. Dans les appels suivants à la même API utilisant les mêmes paramètres, passez l’ETag capturée avec la clé « If-None-Match » dans l’en-tête de requête http. Le code d’état de la réponse est NotModified si les données ne sont pas actualisées plus loin et qu’aucune donnée n’est retournée. L’API retourne le jeu de données complet pour la période requise chaque fois qu’il existe une modification d’etag.

API d’assistance

List Billing Periods (Liste des périodes de facturation) : l’API List Billing Periods renvoie une liste des périodes de facturation contenant les données de consommation pour l’abonnement indiqué, par ordre chronologique inverse. Chaque période contient une propriété qui pointe vers l’itinéraire d’API pour les quatre ensembles de données : BalanceSummary (Solde et résumé), UsageDetails (Détails d’utilisation), Marketplace Charges (Frais de la Place de marché) et PriceSheet (Grille tarifaire).

Codes de réponse HTTP

Code du statut de réponse Message Description
200 OK Aucune erreur
400 Demande incorrecte Paramètres non valides : plages de dates, nombres de Contrats Entreprise (EA), etc.
401 Non autorisé Clé API introuvable, non valide, expirée, etc.
404 Non disponible Point de terminaison de rapport introuvable
429 TooManyRequests La demande a été limitée. Réessayez après avoir attendu le temps spécifié dans l’en-tête x-ms-ratelimit-microsoft.consumption-retry-after.
500 Erreur de serveur Erreur inattendue lors du traitement de la requête
503 ServiceUnavailable Le service est temporairement indisponible. Réessayez après avoir attendu le temps spécifié dans l’en-tête Retry-After.