Delen via

Api-verwijzing voor tenantresourcegebruik

  • Artikel

Een tenant kan de tenant-API's gebruiken om de eigen resourcegebruiksgegevens van de tenant weer te geven. Deze API's zijn consistent met de Azure-gebruiks-API's.

U kunt de Windows PowerShell-cmdlet Get-UsageAggregates gebruiken om gebruiksgegevens op te halen, net zoals in Azure.

API-aanroep

Aanvraag

De aanvraag ontvangt verbruiksgegevens voor de aangevraagde abonnementen en voor het aangevraagde tijdsbestek. Er is geen aanvraagbody.

Methode Aanvraag-URI
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Parameters

Parameter Beschrijving
Armendpoint Azure Resource Manager-eindpunt van uw Azure Stack Hub-omgeving. De Azure Stack Hub-conventie is dat de naam van het Azure Resource Manager-eindpunt de indeling https://management.{domain-name}heeft. Voor de development kit is de domeinnaam bijvoorbeeld local.azurestack.external en is het Resource Manager-eindpunt https://management.local.azurestack.external.
sub-id Abonnements-id van de gebruiker die de oproep doet. U kunt deze API alleen gebruiken om een query uit te voeren op het gebruik van één abonnement. Providers kunnen de API voor resourcegebruik van de provider gebruiken om een query uit te voeren op het gebruik voor alle tenants.
reportedStartTime Begintijd van de query. De waarde voor DateTime moet in UTC en aan het begin van het uur staan, bijvoorbeeld 13:00. Voor dagelijkse aggregatie stelt u deze waarde in op UTC middernacht. De indeling is escaped ISO 8601; Bijvoorbeeld : 2015-06-16T18%3a53%3a11%2b00%3a00Z, waarbij dubbele punt wordt ontsnapt aan %3a en plus wordt ontsnapt aan %2b, zodat deze URI vriendelijk is.
reportedEndTime Eindtijd van de query. De beperkingen die van toepassing zijn op ReportedStartTime zijn ook van toepassing op deze parameter. De waarde voor reportedEndTime kan niet in de toekomst zijn.
aggregationGranularity Optionele parameter met twee discrete mogelijke waarden: dagelijks en elk uur. Zoals de waarden voorstellen, retourneert men de gegevens in dagelijkse granulariteit en de andere is een oplossing per uur. De dagelijkse optie is de standaardoptie.
api-versie Versie van het protocol dat wordt gebruikt om deze aanvraag te doen. U moet 2015-06-01-preview gebruiken.
continuationToken Token opgehaald uit de laatste aanroep naar de provider van de gebruiks-API. Dit token is nodig wanneer een antwoord groter is dan 1000 regels. Het fungeert als bladwijzer voor de voortgang. Als deze niet aanwezig zijn, worden de gegevens opgehaald vanaf het begin van de dag of het uur, op basis van de granulariteit die is doorgegeven.

Respons

GET
/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&api-version=1.0

{
"value": [
{

"id":
"/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregate/sub1-meterID1",
"name": "sub1-meterID1",
"type": "Microsoft.Commerce/UsageAggregate",

"properties": {
"subscriptionId":"sub1",
"usageStartTime": "2015-03-03T00:00:00+00:00",
"usageEndTime": "2015-03-04T00:00:00+00:00",
"instanceData":"{\"Microsoft.Resources\":{\"resourceUri\":\"resourceUri1\",\"location\":\"Alaska\",\"tags\":null,\"additionalInfo\":null}}",
"quantity":2.4000000000,
"meterId":"meterID1"

}
},

...

Responsdetails

Parameter Beschrijving
id Unieke id van de gebruiksaggregaties.
naam Naam van de gebruiksaggregaties.
type Resourcedefinitie.
subscriptionId Abonnements-id van de Azure-gebruiker.
usageStartTime UTC-begintijd van de gebruiksbucket waartoe deze gebruiksaggregaties behoort.
usageEndTime UTC-eindtijd van de gebruiksbucket waartoe deze gebruiksaggregaties behoort.
instanceData Sleutel-waardeparen met instantiedetails (in een nieuwe indeling):
resourceUri: Volledig gekwalificeerde resource-id, inclusief resourcegroepen en exemplaarnaam.
locatie: Regio waarin deze service is uitgevoerd.
tags: Resourcetags die de gebruiker opgeeft.
additionalInfo: Meer informatie over de resource die is verbruikt. Bijvoorbeeld de versie van het besturingssysteem of het type installatiekopie.
quantity Hoeveelheid resourceverbruik dat in dit tijdsbestek is opgetreden.
meterId Unieke id voor de verbruikte resource (ook wel ResourceID genoemd).

Volgende stappen