Delen via

Api-verwijzing voor het gebruik van tenantresources

  • 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 als in Azure.

API-aanroep

Aanvraag

De aanvraag haalt verbruiksgegevens op voor de aangevraagde abonnementen en voor het aangevraagde tijdsbestek. Er is geen aanvraagtekst.

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 https://management.local.azurestack.externalhet Resource Manager eindpunt .
subId Abonnements-id van de gebruiker die de aanroep doet. U kunt deze API alleen gebruiken om het gebruik van één abonnement op te vragen. Providers kunnen de API voor resourcegebruik van de provider gebruiken om het gebruik voor alle tenants op te vragen.
reportedStartTime Begintijd van de query. De waarde voor DateTime moet zijn in UTC en aan het begin van het uur; bijvoorbeeld 13:00. Voor dagelijkse aggregatie stelt u deze waarde in op UTC middernacht. Het formaat is niet iso 8601; bijvoorbeeld 2015-06-16T18%3a53%3a11%2b00%3a00Z, waarbij dubbele punt is ontsnapt aan %3a en plus wordt escaped naar %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 mag niet in de toekomst zijn.
aggregationGranularity Optionele parameter met twee discrete potentiële waarden: dagelijks en elk uur. Zoals de waarden suggereren, retourneert de ene 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 maken. U moet 2015-06-01-preview gebruiken.
continuationToken Token dat is opgehaald uit de laatste aanroep van de api-provider voor gebruik. Dit token is nodig wanneer een antwoord groter is dan 1000 regels. Het fungeert als een bladwijzer voor 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.

Antwoord

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"

}
},

...

Antwoorddetails

Parameter Beschrijving
id Unieke id van de aggregatie van het gebruik.
naam Naam van de gebruiksaggregatie.
type Resourcedefinitie.
subscriptionId Abonnements-id van de Azure-gebruiker.
usageStartTime UTC-begintijd van de gebruiksbucket waartoe deze gebruiksaggregatie behoort.
usageEndTime UTC-eindtijd van de gebruiksbucket waartoe deze gebruiksaggregatie behoort.
instanceData Sleutel-waardeparen van exemplaardetails (in een nieuwe indeling):
resourceUri: volledig gekwalificeerde resource-id, inclusief resourcegroepen en exemplaarnaam.
location: 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ën.
quantity Hoeveelheid resourceverbruik dat is opgetreden in dit tijdsbestek.
meterId Unieke id voor de resource die is verbruikt (ook wel ResourceID genoemd).

Volgende stappen