Azure-verbruik

De API's voor Azure-gebruiksgegevens bieden u programmatische toegang tot de kosten en gebruiksgegevens van uw Azure-resources. Deze API's ondersteunen momenteel alleen Enterprise Enrollments en Web Direct Subscriptions (met een paar uitzonderingen). De API's worden voortdurend bijgewerkt ter ondersteuning van andere typen Azure-abonnementen.

API's voor Azure-gebruiksgegevens bieden toegang tot:

  • Alleen voor Enterprise-klanten
    • Prijzenoverzicht
    • Budgetten
    • Prognoses
    • Tegoeden
    • Tags
    • Kostentags
  • Enterprise- en Web Direct-klanten
    • Reserveringsdetails
    • Reserveringssamenvattingen
    • Marketplace-kosten
    • Gebruiksgegevens
    • Aanbevelingen voor reserveringen

Lijst met niet-ondersteunde abonnementstypen

  • MS-AZR-0145P (CSP)
  • MS-AZR-0146P (CSP)
  • MS-AZR-159P (CSP)
  • MS-AZR-0036P (gesponsord)
  • MS-AZR-0143P (gesponsord)
  • MS-AZR-0015P (intern)
  • MS-AZR-0144P (DreamSpark)

REST-bewerkingsgroepen

Bewerkingsgroep Beschrijving
Budgetten Biedt bewerkingen voor het instellen, bijwerken en verwijderen van budgetten in het bereik van een abonnement of resourcegroep. Ondersteunt kosten- en gebruiksbudgetten.
Prijzenoverzicht Biedt bewerkingen voor het opmaken van prijzen voor Enterprise-abonnementen en factureringsaccounts.
Marketplace-kosten Biedt bewerkingen voor het verkrijgen van gebruiksgegevens voor Marketplace-resources in abonnements- of enterprise-factureringsaccounts.
Gebruiksgegevens Biedt bewerkingen voor het verkrijgen van gebruiksgegevens voor abonnements- of enterprise-factureringsaccounts.
Reserveringsdetails Biedt bewerkingen om het gedetailleerde gebruik van reserveringen voor Betalen per gebruik en Enterprise-abonnementen op te halen.
Rapport reserveringsdetails Biedt bewerkingen voor het krijgen van gedetailleerd gebruik van reserveringen voor Betalen per gebruik en Enterprise-abonnementen in een rapportindeling die is geoptimaliseerd voor grote gegevensgrootten.
Reserveringssamenvattingen Biedt bewerkingen om het gebruik van reserveringsoverzichten voor Betalen per gebruik en Enterprise-abonnementen op te halen.
Aanbevelingen voor reserveringen Biedt bewerkingen voor het krijgen van reserveringsaanbevelingen voor betalen per gebruikt en Enterprise-abonnementen.
Prognoses Biedt bewerkingen voor het op halen van gebruiksprognoses voor Enterprise-abonnementen.
Tegoeden Biedt bewerkingen voor het opmaken van saldi en samenvattingen voor Enterprise-factureringsrekeningen.
Tags Biedt bewerkingen voor het op halen van tags voor Enterprise-abonnementen.

Werken met factureringsperioden en datumbereiken

Gebruiksgegevens en Marketplace-kosten accepteren factureringsperiode of datumbereiken voor het definiëren van de begin- en einddatum voor de gebruiksgegevens.

Hier is het API-gedrag op basis van factureringsperioden en datumbereiken in de aanvraag.

Factureringsperiode aanwezig in aanvraag Begindatum aanwezig in aanvraag Einddatum aanwezig in aanvraag API-gedrag
nee nee nee Gegevens voor de huidige factureringsperiode worden geretourneerd als reactie
nee ja nee Gegevens voor de huidige factureringsperiode worden geretourneerd als reactie
nee nee ja Gegevens voor de huidige factureringsperiode worden geretourneerd als reactie
nee ja ja Gegevens voor opgegeven begin- en einddatum worden geretourneerd als antwoord
ja nee nee Gegevens voor de opgegeven factureringsperiode worden geretourneerd als reactie
ja ja nee Gegevens voor de opgegeven factureringsperiode worden geretourneerd als reactie
ja nee ja Gegevens voor de opgegeven factureringsperiode worden geretourneerd als reactie
ja ja ja Gegevens voor opgegeven begin- en einddatum worden geretourneerd als antwoord. De opgegeven factureringsperiode wordt genegeerd

Het maximaal toegestane datumbereik is 12 maanden in één aanvraag en de gegevens zijn beschikbaar vanaf 1 mei 2014 of hoger.

Lijst met factureringsperioden verkrijgen

Voor het verstrekken van een geldige factureringsperiode in de aanvraag moet de client eerst een lijst met beschikbare factureringsperioden per abonnement krijgen met behulp van de volgende API

   GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods?api-version=2017-04-24-preview

Met behulp van deze lijst kan de client een specifieke factureringsperiode kiezen om verbruiksgegevens op te halen.

Late Arriving-gegevens

Voor services van derden die vertragingen hebben bij het rapporteren van gebruik, wordt de gerapporteerde gebruiksdatum ingesteld op het tijdstip waarop de gebruiksgegevens zijn verzonden, in tegenstelling tot het moment waarop het werkelijke gebruik plaatsvond, dat wil zeggen verbruikstijd.

Als gevolg hiervan wordt het gebruik beoordeeld voor en toegepast op de gerapporteerde tijd. Om de werkelijke verbruikstijd weer te geven, worden de eigenschappen weergegeven. Het veld AdditionalProperties bevat nu twee extra eigenschappen. ConsumptionBeginTime en ConsumptionEndTime zijn de nieuwe velden die overeenkomen met het werkelijke verbruikstijdvenster.

Deze wijzigingen resulteren in een aantal scenario's die moeten worden verholpen bij het aanroepen van de API voor gebruiksgegevens:

  1. Rapportage voor het einde van de maand: voor gebruik dat is opgetreden tijdens een maand, maar dat in de volgende maand is gerapporteerd, moeten klanten het veld additionalProperties bekijken om het gebruik toe te wijzen aan de juiste maand.

  2. Gebruiksgegevens van query's: wanneer u een query uitvoert op de API voor gebruiksgegevens op basis van een datumbereik, is de query alleen van toepassing op de datum van het gebruiksrapport en niet op de verbruikstijd in het veld additionalProperties. Voor klanten die gebruiksgegevens willen in kaart brengen aan facturen, heeft deze update geen invloed op het proces, omdat de factuur het gebruik verwerkt op basis van de datum van het gebruiksrapport. Voor klanten die gebruiksgegevens willen toe te wijsen aan een specifieke kalenderdatum/-maand, is deze update een wijziging die problemen geeft. In deze scenario's kan de datum van het gebruiksrapport niet worden gebruikt en moet de datum waarop het gebruik heeft plaatsgevonden, in de sectie additionalProperties worden gebruikt.

Voorbeeldoproep voor meer informatie:

   GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails?api-version=2018-03-31&$expand=properties/additionalProperties

Voorbeeld van een antwoordfragment:

    "properties":{
        "billingPeriodId":"/subscriptions/{subscriptionid}/providers/Microsoft.Billing/billingPeriods/20180501",
        "usageStart":"2018-05-01T00:00:00.0000000Z",
        "usageEnd":"2018-05-01T23:59:59.0000000Z
        instanceId":"/subscriptions/{subscriptionid}/resourceGroups/{resourcegroup}/providers/Microsoft.Cdn/profiles/{profile}",
        "instanceName":"{id}",
        "instanceLocation":"SouthCentralUS",
        "meterId":"6b88ada0-cbc0-4874-be0e-23004f8b4de7",
        "usageQuantity":0.002065,
        "pretaxCost":0,
        "currency":"USD",
        "additionalProperties":"{
            \"Provider\": \"1\",
            \"ConsumptionBeginTime\": \"2018-05-01T19:00:00\",
            \"ConsumptionEndTime\": \"2018-05-01T20:00:00\"
            }",

Zie ook

Ga voor meer informatie over het gebruik van deze API in een van de taalspecifieke SDK's naar het volgende

Azure Consumption Python SDK

Azure Consumption CLI

Azure Consumption .NET SDK

Azure Consumption NodeJS SDK

Azure Consumption Ruby SDK