Share via


Panoramica delle API di creazione report di Azure Enterprise

Nota

Tutte le API di creazione report enterprise di Azure vengono ritirati. È consigliabile eseguire la migrazione alle API di Gestione costi Microsoft il prima possibile.

Le API di creazione di Azure Enterprise consento ai clienti Enterprise di Azure di estrarre i dati di fatturazione e i dati sull’uso a livello di programmazione per inserirli negli strumenti di analisi preferiti. I clienti aziendali hanno firmato un Contratto Enterprise (EA) con Azure per effettuare il pagamento anticipato di Azure negoziato (precedentemente denominato impegno monetario) e ottenere l'accesso ai prezzi personalizzati per le risorse di Azure.

Tutti i parametri di data e ora necessari per le API devono essere rappresentati come valori UTC (Coordinated Universal Time) combinati. I valori restituiti dalle API sono visualizzati in formato UTC.

Abilitazione dell'API per l'accesso ai dati

  • Generare o recuperare la chiave API: per altre informazioni, vedere Generazione di chiavi API.
  • Passare le chiavi nell'API - La chiave API deve essere passata per ogni chiamata per l'autenticazione e l'autorizzazione. La proprietà seguente deve corrispondere alle intestazioni HTTP.
Chiave intestazione necessaria Valore
Autorizzazione Specificare il valore nel formato: bearer {API_KEY}
Esempio: bearer eyr....09

API basate sul consumo

Un endpoint Swagger è disponibile qui per le API seguenti. Dovrebbero consentire una facile introspezione dell'API e la possibilità di generare sdk (Software Development Kit) client usando AutoRest o Swagger CodeGen. I dati a partire dal 1° maggio 2014 sono disponibili tramite questa API.

  • Saldo e riepilogo: l'API saldo e riepilogo offre un riepilogo mensile delle informazioni sui saldi, i nuovi acquisti, gli addebiti per i servizi di Azure Marketplace, le rettifiche e gli addebiti per eccedenza.

  • Dettagli sull'uso - L'API per dettagli sull'uso offre un'analisi giornaliera dettagliata delle quantità usate e delle spese stimate in relazione a una registrazione. Il risultato include anche informazioni su istanze, contatori e reparti. Eseguire una query sull'API in base al periodo di fatturazione o in base a una data di inizio e di fine specificata.

  • Addebito dello Store del Marketplace: l'APIdi addebito del Marketplace restituisce la suddivisione degli addebiti del Marketplace in base all'utilizzo per giorno per le date di inizio e fine specificate per il periodo di fatturazione o di fine (una sola volta le tariffe non sono incluse).

  • Elenco prezzi - L'API elenco prezzi offre la tariffa applicabile per ogni contatore per la registrazione e il periodo di fatturazione specificati.

  • Dettagli delle istanze riservate - L'API per l'utilizzo di istanze riservate restituisce l'utilizzo degli acquisti di istanze riservate. L'API per gli addebiti per istanze riservate visualizza le transazioni di fatturazione effettuate.

Aggiornamento dei dati

Gli Etag vengono restituiti nella risposta di tutte le API precedenti. Una modifica in Etag indica che i dati sono stati aggiornati. Nelle chiamate successive alla stessa API tramite gli stessi parametri passare l'ETag acquisito con la chiave "If-None-Match" nell'intestazione della richiesta HTTP. Il codice di stato della risposta è NotModified se i dati non vengono aggiornati ulteriormente e non vengono restituiti dati. L'API restituisce il set di dati completo per il periodo richiesto ogni volta che si verifica una modifica dell'etag.

API di supporto

Elenco periodi di fatturazione - L'API per periodi di fatturazione restituisce un elenco di periodi di fatturazione contenente i dati sull'uso per la registrazione specificata in ordine cronologico inverso. Ogni periodo contiene una proprietà che punta alla route API per i quattro set di dati, ovvero BalanceSummary, UsageDetails, MarketplaceCharges e PriceSheet.

Codici di risposta dell'API

Codice di stato della risposta Message Descrizione
200 OK Nessun errore
400 Richiesta non valida Parametri non validi (intervalli di date, numeri EA e così via)
401 Non autorizzata Chiave API non trovata, non valida, scaduta e così via
404 Non disponibile Endpoint del report non trovato
429 TooManyRequests La richiesta è stata limitata. Riprovare dopo aver atteso il tempo specificato nell'intestazione x-ms-ratelimit-microsoft.consumption-retry-after.
500 Errore del server Errore imprevisto nell'elaborazione della richiesta
503 ServiceUnavailable Il servizio è temporaneamente non disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione Retry-After.