Resourcegebruik-API voor providers
De term provider is van toepassing op de servicebeheerder en op alle gedelegeerde providers. Azure Stack Hub-operators en gedelegeerde providers kunnen de API voor providergebruik gebruiken om het gebruik van hun directe tenants weer te geven. Zoals in het volgende diagram wordt weergegeven, kan P0 bijvoorbeeld de api van de provider aanroepen om directe gebruiksinformatie over P1 en P2 op te halen, en kan P1 aanroepen voor gebruiksgegevens op P3 en P4.
Naslaginformatie over API-aanroepen
Aanvraag
De aanvraag haalt verbruiksgegevens op voor de aangevraagde abonnementen en voor het aangevraagde tijdsbestek. Er is geen aanvraagtekst.
Deze gebruiks-API is een provider-API, dus aan de aanroeper moet de rol Eigenaar, Inzender of Lezer worden toegewezen in het abonnement van de provider.
| Methode | Aanvraag-URI |
|---|---|
| GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&subscriberId={sub1.1}&api-version=2015-06-01-preview&continuationToken={token-value} |
Argumenten
| Argument | 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://adminmanagement.{domain-name}heeft. Als de domeinnaam bijvoorbeeld local.azurestack.external is voor de Azure Stack Development Kit (ASDK), is https://adminmanagement.local.azurestack.externalhet Resource Manager eindpunt . |
subId |
Abonnements-id van de gebruiker die de aanroep doet. |
reportedStartTime |
Begintijd van de query. De waarde voor DateTime moet zijn in Utc (Coordinated Universal Time) 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%3a00Zwaarbij de dubbele punt is ontsnapt aan %3a en het plusteken naar, %2b zodat deze geschikt is voor URI. |
reportedEndTime |
Eindtijd van de query. De beperkingen die van toepassing zijn op reportedStartTime , zijn ook van toepassing op dit argument. De waarde voor reportedEndTime mag niet in de toekomst of de huidige datum zijn. Als dat zo is, wordt het resultaat ingesteld op 'verwerking niet voltooid'. |
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. |
subscriberId |
Abonnements-id. Als u gefilterde gegevens wilt ophalen, is de abonnements-id van een directe tenant van de provider vereist. Als er geen abonnements-id-parameter is opgegeven, retourneert de aanroep gebruiksgegevens voor alle directe tenants van de provider. |
api-version |
Versie van het protocol dat wordt gebruikt om deze aanvraag te maken. Deze waarde is ingesteld op 2015-06-01-preview. |
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 de voortgang. Als het token niet aanwezig is, 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.Admin/subscriberUsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&subscriberId=sub1.1&api-version=1.0
{
"value": [
{
"id":
"/subscriptions/sub1.1/providers/Microsoft.Commerce.Admin/UsageAggregate/sub1.1-
meterID1",
"name": "sub1.1-meterID1",
"type": "Microsoft.Commerce.Admin/UsageAggregate",
"properties": {
"subscriptionId":"sub1.1",
"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
| Argument | Beschrijving |
|---|---|
id |
Unieke id van de aggregatie van het gebruik. |
name |
Naam van de gebruiksaggregatie. |
type |
Resourcedefinitie. |
subscriptionId |
Abonnements-id van de Azure Stack Hub-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, die de resourcegroepen en de naam van het exemplaar bevat. location: Regio waarin deze service is uitgevoerd. tags: Resourcetags die zijn opgegeven door de gebruiker. 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 genoemd ResourceID). |
Gebruiksgegevens ophalen
PowerShell
Als u de gebruiksgegevens wilt genereren, moet u resources hebben die actief zijn en actief gebruikmaken van het systeem; bijvoorbeeld een actieve virtuele machine (VM) of een opslagaccount met bepaalde gegevens. Als u niet zeker weet of er resources worden uitgevoerd in de Azure Stack Hub Marketplace, implementeert u een VM en controleert u de blade VM-bewaking om er zeker van te zijn dat deze wordt uitgevoerd. Gebruik de volgende PowerShell-cmdlets om de gebruiksgegevens weer te geven:
Configureer de Azure Stack Hub-gebruiker of de PowerShell-omgeving van de Azure Stack Hub-operator .
Als u de gebruiksgegevens wilt ophalen, roept u de PowerShell-cmdlet Get-AzsSubscriberUsage aan :
Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
REST-API
U kunt gebruiksgegevens voor verwijderde abonnementen verzamelen door de service Microsoft.Commerce.Beheer aan te roepen.
Alle tenantgebruik voor verwijderd voor actieve gebruikers retourneren
| Methode | Aanvraag-URI |
|---|---|
| GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview |
Gebruik voor verwijderde of actieve tenant retourneren
| Methode | Aanvraag-URI |
|---|---|
| GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&subscriberId={subscriber-id}&api-version=2015-06-01-preview |