Azure-verbruik
De API's voor Azure-gebruiksgegevens bieden u programmatische toegang tot de kosten en gebruiksgegevens van uw Azure-resources. De API's ondersteunen momenteel alleen Enterprise-inschrijvingen, Web Direct-abonnementen (met enkele uitzonderingen) 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 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)
Werken met factureringsperioden en datumbereiken
Gebruiksgegevens en Marketplace-kosten accepteren factureringsperioden of datumbereiken voor het definiëren van de begin- en einddatum voor de gebruiksgegevens.
Hier ziet u het API-gedrag op basis van factureringsperioden en datumbereiken in 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 de opgegeven begin- en einddatum worden als antwoord geretourneerd |
| 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 de opgegeven begin- en einddatum worden geretourneerd als reactie, opgegeven factureringsperiode wordt genegeerd |
Maximaal toegestaan datumbereik is 12 maanden in één aanvraag en gegevens zijn beschikbaar vanaf 1 mei 2014 of later.
Lijst met factureringsperioden verkrijgen
Voor het opgeven van een geldige factureringsperiode in aanvraag, moet de client eerst een lijst met beschikbare factureringsperioden per abonnement ophalen, 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 klant een specifieke factureringsperiode kiezen om verbruiksgegevens op te halen.
Gegevens die te laat binnenkomen
Om rekening te houden met 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 plaats van wanneer het werkelijke gebruik plaatsvond, dat wil gezegd, 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 aangepakt bij het aanroepen van de API voor gebruiksgegevens:
Rapportage over het einde van de maand: Voor gebruik dat is opgetreden tijdens een maand, maar in de volgende maand wordt gerapporteerd, moeten klanten het veld additionalProperties bekijken om het gebruik toe te wijzen aan de juiste maand.
Details van querygebruik: 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 aan facturen willen toewijzen, 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 toewijzen aan een specifieke kalenderdatum/maand, is deze update een wijziging die fouten veroorzaakt. Voor deze scenario's kan de gebruiksrapportdatum niet worden gebruikt en moet de datum waarop het gebruik is opgetreden, in de sectie additionalProperties worden gebruikt.
Voorbeeldoproep voor aanvullende informatie:
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails?api-version=2018-03-31&$expand=properties/additionalProperties
Voorbeeld van 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 de volgende onderwerpen voor meer informatie over het gebruik van deze API in een van de taalspecifieke SDK's