Api voor resourcegebruik van provider
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 provider-API aanroepen om directe gebruiksgegevens op P1 en P2 op te halen, en kan P1 gebruiksgegevens op P3 en P4 aanroepen.
API-aanroepreferentie
Verzoek
De aanvraag ontvangt verbruiksgegevens voor de aangevraagde abonnementen en voor het aangevraagde tijdsbestek. Er is geen aanvraagbody.
Deze gebruiks-API is een provider-API, dus de aanroeper moet een eigenaar, inzenderof lezer rol in het abonnement van de provider krijgen toegewezen.
| Methode | Aanvraag-URI |
|---|---|
| TOEVOEGEN | 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 heeft https://adminmanagement.{domain-name}. Als de domeinnaam bijvoorbeeld local.azurestack.externalis, wordt het Resource Manager-eindpunt https://adminmanagement.local.azurestack.externalvoor de Azure Stack Development Kit (ASDK). |
subId |
Abonnements-id van de gebruiker die de oproep doet. |
reportedStartTime |
Begintijd van de query. De waarde voor DateTime moet zich in Coordinated Universal Time (UTC) en aan het begin van het uur bevinden; bijvoorbeeld 13:00 uur. Voor dagelijkse aggregatie stelt u deze waarde in op UTC middernacht. Het formaat is escaping ISO 8601; bijvoorbeeld, 2015-06-16T18%3a53%3a11%2b00%3a00Z, waarbij de dubbele punt naar %3a en het plusteken naar %2b wordt geescaped zodat het URI-vriendelijk is. |
reportedEndTime |
Eindtijd van de query. De beperkingen die van toepassing zijn op reportedStartTime zijn ook van toepassing op dit argument. De waarde voor reportedEndTime kan 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 mogelijke waarden: dagelijkse en elk uur. Zoals uit de waarden blijkt, worden de gegevens in dagelijkse granulariteit geretourneerd, terwijl de andere een uurlijke resolutie heeft. De optie dagelijks is de standaardinstelling. |
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 doen. Deze waarde is ingesteld op 2015-06-01-preview. |
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 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 gebruikssamenvatting. |
name |
Naam van de gebruiksaggregaties. |
type |
Definitie van hulpbron. |
subscriptionId |
Abonnements-id van de Azure Stack Hub-gebruiker. |
usageStartTime |
UTC-begintijd van de gebruiksbucket waartoe dit gebruiksaggregaat behoort. |
usageEndTime |
UTC-eindtijd van de gebruiksbalk waartoe dit gebruiksaggregaat behoort. |
instanceData |
Sleutel-waardeparen met instantiedetails (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 door de gebruiker zijn opgegeven. additionalInfo: meer informatie over de verbruikte resource; Bijvoorbeeld de versie van het besturingssysteem of het type installatiekopie. |
quantity |
Hoeveelheid middelenverbruik dat in dit tijdsbestek is opgetreden. |
meterId |
Unieke id voor de verbruikte resource (ook wel ResourceIDgenoemd). |
Gebruiksgegevens ophalen
PowerShell
Als u de gebruiksgegevens wilt genereren, moet u resources hebben die worden uitgevoerd en actief gebruikmaken van het systeem; Bijvoorbeeld een actieve virtuele machine (VM) of een opslagaccount met enkele gegevens. Als u niet zeker weet of er resources worden uitgevoerd in de Azure Stack Hub Marketplace, zou u een VM moeten implementeren en het VM-bewakingsblad controleren om te verifiëren of deze wordt uitgevoerd. Gebruik de volgende PowerShell-cmdlets om de gebruiksgegevens weer te geven:
de Azure Stack Hub-gebruiker configureren of de Azure Stack Hub-operator PowerShell-omgeving.
Als u de gebruiksgegevens wilt ophalen, roept u de Get-AzsSubscriberUsage PowerShell-cmdlet aan:
Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
REST API
U kunt gebruiksgegevens verzamelen voor verwijderde abonnementen door de Microsoft.Commerce.Admin--service aan te roepen.
Geef het gebruik van alle tenants terug voor verwijderde en actieve gebruikers.
| Methode | Aanvraag-URI |
|---|---|
| TOEVOEGEN | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview |
Gebruik herstellen voor verwijderde of actieve tenant
| Methode | Aanvraag-URI |
|---|---|
| TOEVOEGEN | 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 |