Delen via


Azure-verbruik

De API's voor Azure-gebruiksgegevens bieden u programmatische toegang tot de kosten en gebruiksgegevens van uw Azure-resources. De API's bieden momenteel alleen ondersteuning voor Enterprise-inschrijvingen, Web Direct-abonnementen (op enkele uitzonderingen na) en CSP Azure-abonnementsabonnementen. De API's worden voortdurend bijgewerkt ter ondersteuning van andere typen Azure-abonnementen.

API's voor Azure-gebruiksgegevens bieden toegang tot:

  • Alleen voor zakelijke klanten
    • Prijslijst
    • Begrotingen
    • Prognoses
    • Balances
    • Tags
    • Kostenplaatjes
  • Enterprise en Web Direct-klanten
    • Reserveringsdetails
    • Reserveringssamenvattingen
    • Marketplace-kosten
    • Gebruiksgegevens
    • Aanbevelingen voor reserveringen

Lijst met niet-ondersteunde abonnementstypen

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

Werken met factureringsperioden en perioden

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

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

Aanvraagperiode Startdatum op verzoek Einddatum op verzoek API-gedrag
Nee Nee Nee Gegevens voor de huidige factureringsperiode worden als reactie geretourneerd
Nee ja Nee Gegevens voor de huidige factureringsperiode worden als reactie geretourneerd
Nee Nee ja Gegevens voor de huidige factureringsperiode worden als reactie geretourneerd
Nee ja ja Gegevens voor de opgegeven start- en einddatum worden als reactie geretourneerd
ja Nee Nee Gegevens voor de gespecificeerde factureringsperiode worden als reactie geretourneerd
ja ja Nee Gegevens voor de gespecificeerde factureringsperiode worden als reactie geretourneerd
ja Nee ja Gegevens voor de gespecificeerde factureringsperiode worden als reactie geretourneerd
ja ja ja Gegevens voor de opgegeven start- en einddatum worden geretourneerd als reactie, de opgegeven factureringsperiode wordt genegeerd

De maximaal toegestane periode is 12 maanden in één aanvraag en gegevens zijn beschikbaar vanaf 1 mei 2014 of later.

Lijst met factureringsperioden ophalen

Om een geldige factureringsperiode in een verzoek te voorzien, moet de klant eerst een lijst van beschikbare factureringsperioden per abonnement opvragen 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 de lijst kan de klant een specifieke factureringsperiode kiezen om verbruiksgegevens te verkrijgen.

Gegevens over te laat aankomen

Om derde-partijdiensten te accommoderen die vertragingen ondervinden bij het rapporteren van het gebruik, wordt de gerapporteerde gebruiksdatum ingesteld op het tijdstip waarop de gebruiksgegevens zijn verzonden, in plaats van wanneer het daadwerkelijke gebruik plaatsvond, oftewel de verbruikstijd.

Als gevolg hiervan wordt het gebruik beoordeeld voor en toegepast op de gerapporteerde tijd. Om de daadwerkelijke consumptietijd weer te geven, de eigenschappen. Het veld AdditionalProperties zal nu twee andere eigenschappen bevatten. ConsumptionBeginTime en ConsumptionEndTime zijn de nieuwe velden die overeenkomen met het werkelijke tijdsvenster voor verbruik.

Deze wijzigingen leiden tot een paar scenario's die moeten worden aangepakt bij het aanroepen van de gebruiksdetails API:

  1. Maandeinderapportage: Voor gebruik dat tijdens een maand plaatsvond, maar in de volgende maand werd gerapporteerd, moeten klanten het veld additionalProperties bekijken om het gebruik aan de juiste maand toe te wijzen.

  2. Gebruiksdetails opvragen: Wanneer je de gebruiksdetails API op een datumbereik opvraagt, geldt de query alleen voor de gebruiksrapportdatum en niet voor de verbruikstijd in het addedalProperties-veld . Voor klanten die gebruiksgegevens aan facturen willen koppelen, beïnvloedt deze update het proces niet, omdat de factuur het gebruik verwerkt op basis van de gebruiksrapportdatum. Voor klanten die gebruiksgegevens willen koppelen aan een specifieke kalenderdatum/maand, is deze update een breaking change en voor deze scenario's kan de gebruiksrapportdatum niet worden gebruikt en moet de datum waarop het gebruik plaatsvond, in de sectie additionalProperties, worden gebruikt.

Voorbeeldcall voor meer details:

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 naar het volgende voor meer informatie over het gebruik van deze API in een van de taalspecifieke SDK's

Azure Consumption Python SDK

Azure Consumption CLI

Azure Consumption NodeJS SDK

Azure Consumption Ruby SDK