API för providerresursanvändning
Termen provider gäller för tjänstadministratören och eventuella delegerade leverantörer. Azure Stack Hub-operatörer och delegerade leverantörer kan använda API:et för provideranvändning för att visa användningen av sina direkta klientorganisationer. Som du ser i följande diagram kan P0 till exempel anropa provider-API:et för att få direkt användningsinformation på P1 och P2, och P1 kan anropa användningsinformation på P3 och P4.
Referens för API-anrop
Förfrågan
Begäran hämtar förbrukningsinformation för de begärda prenumerationerna och för den begärda tidsramen. Det finns ingen begärandetext.
Det här användnings-API:et är ett provider-API, så anroparen måste tilldelas rollen Ägare, Deltagare eller Läsare i providerns prenumeration.
| Metod | URI för förfrågan |
|---|---|
| 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} |
Argument
| Argument | Description |
|---|---|
armendpoint |
Azure Resource Manager slutpunkt för din Azure Stack Hub-miljö. Azure Stack Hub-konventionen är att namnet på Azure Resource Manager-slutpunkten har formatet https://adminmanagement.{domain-name}. Om domännamnet till exempel är local.azurestack.external för Azure Stack Development Kit (ASDK) är https://adminmanagement.local.azurestack.externalResource Manager slutpunkten . |
subId |
Prenumerations-ID för den användare som gör anropet. |
reportedStartTime |
Starttid för frågan. Värdet för DateTime ska vara i Coordinated Universal Time (UTC) och i början av timmen, till exempel 13:00. För daglig aggregering anger du det här värdet till UTC midnatt. Formatet är undantaget ISO 8601; till exempel 2015-06-16T18%3a53%3a11%2b00%3a00Z, där kolonet är undantaget till %3a och plustecknet är undantaget så %2b att det är URI-vänligt. |
reportedEndTime |
Sluttid för frågan. De begränsningar som gäller för reportedStartTime gäller även för det här argumentet. Värdet för reportedEndTime får inte vara antingen i framtiden eller aktuellt datum. Om så är fallet är resultatet inställt på "bearbetningen är inte slutförd". |
aggregationGranularity |
Valfri parameter som har två diskreta potentiella värden: varje dag och varje timme. Som värdena antyder returnerar en data i daglig kornighet och den andra är en timupplösning. Det dagliga alternativet är standard. |
subscriberId |
Prenumerations-ID. För att hämta filtrerade data krävs prenumerations-ID för en direkt klientorganisation för providern. Om ingen parameter för prenumerations-ID anges returnerar anropet användningsdata för alla providerns direkta klienter. |
api-version |
Version av protokollet som används för att göra den här begäran. Det här värdet är inställt på 2015-06-01-preview. |
continuationToken |
Token som hämtats från det senaste anropet till api-providern för användning. Denna token behövs när ett svar är större än 1 000 rader. Den fungerar som ett bokmärke för förloppet. Om token inte finns hämtas data från början av dagen eller timmen, baserat på den kornighet som skickades in. |
Svarsåtgärder
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"
}
},
. . .
Svarsinformation
| Argument | Description |
|---|---|
id |
Unikt ID för användningsmängden. |
name |
Namnet på användningsmängden. |
type |
Resursdefinition. |
subscriptionId |
Prenumerationsidentifierare för Azure Stack Hub-användaren. |
usageStartTime |
UTC-starttiden för användningsbucketen som den här användningsmängden tillhör. |
usageEndTime |
UTC-sluttiden för den användningsbucket som den här användningsmängden tillhör. |
instanceData |
Nyckel/värde-par med instansinformation (i ett nytt format):resourceUri: Fullständigt kvalificerat resurs-ID, som innehåller resursgrupperna och instansnamnet. location: Region där den här tjänsten kördes. tags: Resurstaggar som anges av användaren. additionalInfo: Mer information om resursen som förbrukades; till exempel operativsystemets version eller avbildningstyp. |
quantity |
Mängden resursförbrukning som inträffat under den här tidsramen. |
meterId |
Unikt ID för den resurs som förbrukades (kallas ResourceIDäven ). |
Hämta användningsinformation
PowerShell
Om du vill generera användningsdata bör du ha resurser som körs och aktivt använder systemet. till exempel en aktiv virtuell dator (VM) eller ett lagringskonto som innehåller vissa data. Om du inte är säker på om du har några resurser som körs på Azure Stack Hub Marketplace distribuerar du en virtuell dator och kontrollerar övervakningsbladet för den virtuella datorn för att kontrollera att den körs. Använd följande PowerShell-cmdletar för att visa användningsdata:
Konfigurera Azure Stack Hub-användaren eller Azure Stack Hub-operatörens PowerShell-miljö.
Om du vill hämta användningsdata anropar du PowerShell-cmdleten Get-AzsSubscriberUsage :
Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
REST-API
Du kan samla in användningsinformation för borttagna prenumerationer genom att anropa tjänsten Microsoft.Commerce.Admin.
Returnera all klientanvändning för borttagna för aktiva användare
| Metod | URI för förfrågan |
|---|---|
| GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview |
Returnera användning för borttagen eller aktiv klientorganisation
| Metod | URI för förfrågan |
|---|---|
| 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 |