Übersicht über die Berichterstellungs-APIs für Azure Enterprise

  • Artikel

Hinweis

Alle Azure Enterprise Reporting-APIs werden eingestellt. Sie sollten so bald wie möglich zu Microsoft Cost Management-APIs migrieren.

Die Berichterstellungs-APIs für Azure Enterprise ermöglichen es Azure-Unternehmenskunden, die Verbrauchs- und Abrechnungsdaten in bevorzugten Datenanalysetools abzurufen. Enterprise-Kunden haben eine Konzernvertrag (EA) mit Azure unterzeichnet, um die ausgehandelte Azure-Vorzahlung (zuvor als geldpolitische Verpflichtung bezeichnet) zu erstellen und Zugriff auf benutzerdefinierte Preise für Azure-Ressourcen zu erhalten.

Alle Datums- und Uhrzeitparameter, die für APIs benötigt werden, müssen als kombinierte UTC-Werte (Coordinated Universal Time) angegeben werden. Die von APIs zurückgegebenen Werte werden im UTC-Format angezeigt.

Aktivieren des Datenzugriffs für die API

  • Generieren oder Abrufen des API-Schlüssels – Weitere Informationen finden Sie unter API-Schlüsselgenerierung.
  • Übergeben von Schlüsseln in der API: Der API-Schlüssel muss für jeden Aufruf für die Authentifizierung und Autorisierung übergeben werden. Die folgende Eigenschaft muss sich in den HTTP-Headern befinden.
Anforderungsheaderschlüssel Wert
Authorization Geben Sie den Wert im folgenden Format an: bearer {API_SCHLÜSSEL}
Beispiel: bearer eyr....09

Nutzungsbasierte APIs

Ein Swagger-Endpunkt ist hier für die folgenden APIs verfügbar. Sie sollten eine einfache Introspektion der API und die Möglichkeit zum Generieren von Clientsoftwareentwicklungskits (SDK)s mithilfe von AutoRest oder Swagger CodeGen ermöglichen. Seit dem 1. Mai 2014 sind Daten über diese API verfügbar.

  • Saldo und Zusammenfassung – Die Saldo- und Zusammenfassungs-API bietet eine monatliche Zusammenfassung der Informationen zu Saldos, neuen Käufen, Azure Marketplace-Servicegebühren, Anpassungen und Überlastungsgebühren.

  • Verwendungsdetails: Die API für Verwendungsdetails bietet eine tägliche Aufschlüsselung der verbrauchten Mengen und durch eine Registrierung anfallenden geschätzten Kosten. Das Ergebnis umfasst auch Informationen zu Instanzen, Verbrauchseinheiten und Abteilungen. Fragen Sie die API nach Abrechnungszeitraum oder nach einem angegebenen Anfangs- und Enddatum ab.

  • Marketplace Store Charge - Die Marketplace Store Charge API gibt die nutzungsbasierten Marketplace-Gebühren nach Tag für den angegebenen Abrechnungszeitraum oder Start- und Enddaten zurück (einmalige Gebühren sind nicht enthalten).

  • Preisblatt: Die Preisblatt-API stellt die zutreffende Rate für jede Verbrauchseinheit für den angegebenen Registrierungs- und Abrechnungszeitraum bereit.

  • Details der reservierten Instanz: Die API zur Nutzung reservierter Instanzen gibt die Nutzung der Käufe reservierter Instanzen zurück. Die API für Gebühren für reservierte Instanzen zeigt die vorgenommenen Transaktionsabrechnungen an.

Datenaktualität

Etags werden in der Antwort aller oben genannten API zurückgegeben. Eine Änderung in Etag gibt an, dass die Daten aktualisiert wurden. Übergeben Sie in nachfolgenden Aufrufen der gleichen API mit den gleichen Parametern das erfasste ETag mit dem Schlüssel „If-None-Match“ im Header der HTTP-Anforderung. Der Antwortstatuscode ist NotModified , wenn die Daten nicht weiter aktualisiert werden und keine Daten zurückgegeben werden. DIE API gibt das vollständige Dataset für den erforderlichen Zeitraum zurück, wenn sich ein Etag ändert.

Hilfs-APIs

Liste der Abrechnungszeiträume: Die API für Abrechnungszeiträume gibt eine Liste von Abrechnungszeiträumen zurück, die Verbrauchsdaten für die angegebene Registrierung in umgekehrter chronologischer Reihenfolge enthalten. Jeder Zeitraum enthält eine Eigenschaft, die auf die API-Route für die vier Datensätze verweist: BalanceSummary, UsageDetails, Marketplace Charges und PriceSheet.

API-Antwortcodes

Statuscode der Antwort `Message` BESCHREIBUNG
200 OK Kein Fehler
400 Ungültige Anforderung Ungültige Parameter – Datumsbereiche, EA-Nummern usw.
401 Nicht autorisiert API-Schlüssel nicht gefunden, ungültig, abgelaufen usw.
404 Nicht verfügbar Berichtsendpunkt nicht gefunden
429 TooManyRequests Die Anforderung wurde gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie die im Header x-ms-ratelimit-microsoft.consumption-retry-after angegebene Zeit abgewartet haben.
500 Serverfehler Unerwarteter Fehler beim Verarbeiten der Anforderung
503 ServiceUnavailable Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header Retry-After angegebene Zeit abgewartet haben.