API-naslaginformatie over het gebruik van tenantresources
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 aanvraag body.
| Methode | Aanvraag-URI |
|---|---|
| GET | https://{{{dpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-previewcontinuationToken&={token-value} |
Parameters
| Parameter | Beschrijving |
|---|---|
| Hadopunt | Azure Resource Manager eindpunt van uw Azure Stack Hub omgeving. De Azure Stack Hub is dat de naam van Azure Resource Manager eindpunt de indeling heeft https://management.{domain-name}. Voor de Development Kit is de domeinnaam bijvoorbeeld local.azurestack.external en is Resource Manager eindpunt https://management.local.azurestack.external. |
| subId | 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 providers gebruiken om query's uit te voeren op het gebruik voor alle tenants. |
| reportedStartTime | Begintijd van de query. De waarde voor DateTime moet in UTC zijn en aan het begin van het uur; bijvoorbeeld 13:00. Voor dagelijkse aggregatie stelt u deze waarde in op UTC middernacht. De indeling is iso 8601 als escape-bestand; Bijvoorbeeld 2015-06-16T18%3a53%3a11%2b00%3a00Z, waarbij een dubbele punt wordt escaped naar %3a en plus wordt overgenomen in %2b, zodat deze URI-gebruiksvriendelijk 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 afzonderlijke mogelijke waarden: dagelijksen elk uur. Zoals de waarden voorstellen, retourneert de ene de gegevens in dagelijkse granulariteit en de andere een resolutie per uur. De dagelijkse optie is de standaardinstelling. |
| api-versie | Versie van het protocol dat wordt gebruikt om deze aanvraag te maken. U moet 2015-06-01-preview gebruiken. |
| continuationToken | Token opgehaald uit de laatste aanroep naar de API-provider voor gebruik. Dit token is nodig wanneer een antwoord groter is dan 1000 regels. Deze fungeert als een bladwijzer voor de voortgang. Als deze niet aanwezig zijn, worden de gegevens opgehaald aan 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 combinatie van gebruik. |
| naam | Naam van de aggregatie van het gebruik. |
| type | Resourcedefinitie. |
| subscriptionId | Abonnements-id van de Azure-gebruiker. |
| usageStartTime | UTC-begintijd van de gebruiks bucket waarvan deze gebruiksaggregatie deel uitmaken. |
| usageEndTime | UTC-eindtijd van de gebruiks bucket waarvan deze gebruiksaggregatie deel uitmaken. |
| instanceData | Sleutel-waardeparen van instantiedetails (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 op geeft. additionalInfo: meer informatie over de resource die is verbruikt. Bijvoorbeeld besturingssysteemversie of afbeeldingstype. |
| quantity | De hoeveelheid resourceverbruik die in dit tijdsbestek is opgetreden. |
| meterId | Unieke id voor de resource die is verbruikt (ook wel ResourceID genoemd). |