Szolgáltatói erőforrás-használati APIProvider resource usage API

A szolgáltató kifejezés a szolgáltatás-rendszergazdára és a delegált szolgáltatókra is érvényes.The term provider applies to the service administrator and to any delegated providers. Azure Stack hub-operátorok és a delegált szolgáltatók használhatják a szolgáltatói használati API-t a közvetlen bérlők használatának megtekintésére.Azure Stack Hub operators and delegated providers can use the provider usage API to view the usage of their direct tenants. Például az alábbi ábrán látható módon a P0 meghívhatja a szolgáltatói API-t a közvetlen használati adatok lekérésére a P1 és P2 címen, a P1 pedig a P3-as és a P4-es használati adatokat hívhatja meg.For example, as shown in the following diagram, P0 can call the provider API to get direct usage information on P1 and P2, and P1 can call for usage information on P3 and P4.

A szolgáltatói hierarchia fogalmi modellje

API-hívás referenciájaAPI call reference

KérésRequest

A kérelem lekéri a kért előfizetések és a kért időkeret felhasználásának részleteit.The request gets consumption details for the requested subscriptions and for the requested time frame. Nincs kérelem törzse.There's no request body.

Ez a használati API egy szolgáltatói API, így a hívónak hozzá kell rendelnie egy tulajdonos, közreműködő vagy olvasó szerepkört a szolgáltató előfizetésében.This usage API is a provider API, so the caller must be assigned an Owner, Contributor, or Reader role in the provider's subscription.

MetódusMethod Kérés URI-jaRequest URI
GETGET 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}

ArgumentumokArguments

ArgumentumArgument LeírásDescription
armendpoint Azure Resource Manager a Azure Stack hub-környezet végpontját.Azure Resource Manager endpoint of your Azure Stack Hub environment. Az Azure Stack hub-egyezmény azt adja meg, hogy a Azure Resource Manager végpont neve a (z) formátumban van https://adminmanagement.{domain-name} .The Azure Stack Hub convention is that the name of the Azure Resource Manager endpoint is in the format https://adminmanagement.{domain-name}. Például a Azure Stack Development Kit (ASDK) esetében, ha a tartománynév helyi. azurestack. external, akkor a Resource Manager-végpont a következő: https://adminmanagement.local.azurestack.external .For example, for the Azure Stack Development Kit (ASDK), if the domain name is local.azurestack.external, then the Resource Manager endpoint is https://adminmanagement.local.azurestack.external.
subId Annak a felhasználónak az előfizetés-azonosítója, aki a hívást kezdeményezi.Subscription ID of the user who makes the call.
reportedStartTime A lekérdezés kezdési időpontja.Start time of the query. Az értéknek az DateTime egyezményes világidő (UTC) és az óra elején kell lennie, például: 13:00.The value for DateTime should be in Coordinated Universal Time (UTC) and at the beginning of the hour; for example, 13:00. A napi összesítéshez állítsa ezt az értéket UTC éjfélre.For daily aggregation, set this value to UTC midnight. A formátum megmenekült ISO 8601; például, 2015-06-16T18%3a53%3a11%2b00%3a00Z Ha a kettőspont megmenekül, %3a és a plusz megmenekül, hogy %2b URI-barát legyen.The format is escaped ISO 8601; for example, 2015-06-16T18%3a53%3a11%2b00%3a00Z, where the colon is escaped to %3a and the plus is escaped to %2b so that it's URI-friendly.
reportedEndTime A lekérdezés befejezési időpontja.End time of the query. A rájuk vonatkozó korlátozások reportedStartTime erre az argumentumra is érvényesek.The constraints that apply to reportedStartTime also apply to this argument. Az érték reportedEndTime nem lehet a jövőben vagy az aktuális dátum.The value for reportedEndTime can't be either in the future, or the current date. Ha igen, az eredmény "feldolgozás nem fejeződött be" értékre van állítva.If it is, the result is set to "processing not complete."
aggregationGranularity Opcionális paraméter, amely két különálló lehetséges értékkel rendelkezik: naponta és óránként.Optional parameter that has two discrete potential values: daily and hourly. Az értékek azt sugallják, hogy az egyik napi részletességgel adja vissza az adatokat, a másik pedig óradíjas megoldás.As the values suggest, one returns the data in daily granularity, and the other is an hourly resolution. A napi beállítás az alapértelmezett.The daily option is the default.
subscriberId Előfizetés azonosítója.Subscription ID. A szűrt adatlekérdezéshez a szolgáltató közvetlen bérlője előfizetés-AZONOSÍTÓjának megadása szükséges.To get filtered data, the subscription ID of a direct tenant of the provider is required. Ha nincs megadva előfizetés-azonosító paraméter, a hívás az összes szolgáltató közvetlen bérlője használati adatait adja vissza.If no subscription ID parameter is specified, the call returns usage data for all the provider's direct tenants.
api-version A kérelem elvégzéséhez használt protokoll verziója.Version of the protocol that's used to make this request. Ez az érték a következőre van beállítva: 2015-06-01-preview .This value is set to 2015-06-01-preview.
continuationToken A rendszer a használati API-szolgáltató utolsó hívásával lekért tokent.Token retrieved from the last call to the usage API provider. Erre a tokenre akkor van szükség, ha a válasz nagyobb, mint 1 000 sor.This token is needed when a response is greater than 1,000 lines. A folyamat könyvjelzőként működik.It acts as a bookmark for the progress. Ha a jogkivonat nincs jelen, az adatok a nap vagy az óra elejétől kezdve, az átadott részletesség alapján kerülnek beolvasásra.If the token isn't present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

ReagálásResponse

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"

}
},

. . .

Válasz részleteiResponse details

ArgumentumArgument LeírásDescription
id A használati összesítés egyedi azonosítója.Unique ID of the usage aggregate.
name A használati összesítés neve.Name of the usage aggregate.
type Erőforrás-definíció.Resource definition.
subscriptionId Az Azure Stack hub-felhasználó előfizetés-azonosítója.Subscription identifier of the Azure Stack Hub user.
usageStartTime Annak a használati gyűjtőnek az UTC szerinti kezdési időpontja, amelyhez ez a használati összesítés tartozik.UTC start time of the usage bucket to which this usage aggregate belongs.
usageEndTime Azon használati gyűjtő UTC-befejezési időpontja, amelyhez ez a használati összesítés tartozik.UTC end time of the usage bucket to which this usage aggregate belongs.
instanceData Példány részleteinek kulcs-érték párok (új formátumban):Key-value pairs of instance details (in a new format):
resourceUri: Teljes körű erőforrás-azonosító, amely magában foglalja az erőforráscsoportot és a példány nevét.resourceUri: Fully qualified resource ID, which includes the resource groups and the instance name.
location: Az a régió, amelyben a szolgáltatást futtatták.location: Region in which this service was run.
tags: A felhasználó által megadott erőforrás-címkék.tags: Resource tags that are specified by the user.
additionalInfo: További információ a felhasznált erőforrásról; például az operációs rendszer verziója vagy a rendszerkép típusa.additionalInfo: More details about the resource that was consumed; for example, the OS version or image type.
quantity Az adott időkeretben bekövetkezett erőforrás-felhasználás mennyisége.Amount of resource consumption that occurred in this time frame.
meterId A felhasznált erőforrás egyedi azonosítója (más néven ResourceID ).Unique ID for the resource that was consumed (also called ResourceID).

Használati adatok beolvasásaRetrieve usage information

PowerShellPowerShell

A használati adatok létrehozásához a rendszert futtató és aktívan használt erőforrásokkal kell rendelkeznie. például egy aktív virtuális gép (VM) vagy egy bizonyos adathalmazt tartalmazó Storage-fiók.To generate the usage data, you should have resources that are running and actively using the system; for example, an active virtual machine (VM), or a storage account containing some data. Ha nem biztos abban, hogy rendelkezik-e a Azure Stack hub piactéren futó erőforrásokkal, helyezzen üzembe egy virtuális gépet, és ellenőrizze, hogy fut-e a virtuális gép figyelése panel.If you're not sure whether you have any resources running in the Azure Stack Hub Marketplace, deploy a VM, and verify the VM monitoring blade to make sure it's running. Használja a következő PowerShell-parancsmagokat a használati adatok megtekintéséhez:Use the following PowerShell cmdlets to view the usage data:

  1. Telepítse a powershellt Azure stack hubhoz.Install PowerShell for Azure Stack Hub.

  2. Konfigurálja a Azure stack hub-felhasználót vagy a Azure stack hub-kezelő PowerShell-környezetét.Configure the Azure Stack Hub user or the Azure Stack Hub operator PowerShell environment.

  3. A használati adatok lekéréséhez hívja meg a Get-AzsSubscriberUsage PowerShell-parancsmagot:To retrieve the usage data, call the Get-AzsSubscriberUsage PowerShell cmdlet:

    Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
    

REST APIREST API

A törölt előfizetésekre vonatkozó használati adatokat a Microsoft. Commerce. admin szolgáltatás meghívásával gyűjthet.You can collect usage information for deleted subscriptions by calling the Microsoft.Commerce.Admin service.

Az összes bérlői használat visszaküldése aktív felhasználók számáraReturn all tenant usage for deleted for active users

MetódusMethod Kérés URI-jaRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview

Törölt vagy aktív bérlő használatának visszaküldéseReturn usage for deleted or active tenant

MetódusMethod Kérés URI-jaRequest URI
GETGET 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

Következő lépésekNext steps