API för providerresursanvändningProvider resource usage API

Termen Provider gäller tjänst administratören och alla delegerade providrar.The term provider applies to the service administrator and to any delegated providers. Azure Stack Hub-operatörer och delegerade leverantörer kan använda API: et för provider användning för att visa användningen av sina direkta klienter.Azure Stack Hub operators and delegated providers can use the provider usage API to view the usage of their direct tenants. Som du ser i följande diagram kan P0 till exempel anropa Provider-API: et för att få direkt användnings information på P1 och P2, och P1 kan anropa användnings information på P3 och P4.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.

Konceptuell modell för providerns hierarki

Referens för API-anropAPI call reference

FörfråganRequest

Begäran får information om förbrukningen för de begärda prenumerationerna och för den begärda tids perioden.The request gets consumption details for the requested subscriptions and for the requested time frame. Det finns ingen begär ande text.There's no request body.

Det här användnings-API: et är ett Provider-API, så att anroparen måste tilldelas rollen ägare , deltagare eller läsare i providerns prenumeration.This usage API is a provider API, so the caller must be assigned an Owner , Contributor , or Reader role in the provider's subscription.

MetodMethod URI för förfråganRequest 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}

ArgumentArguments

ArgumentArgument BeskrivningDescription
armendpoint Azure Resource Manager slut punkten för din Azure Stack Hub-miljö.Azure Resource Manager endpoint of your Azure Stack Hub environment. Azure Stack Hub-konventionen är att namnet på Azure Resource Manager slut punkten är i formatet 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}. Till exempel för Azure Stack Development Kit (ASDK), om domän namnet är lokalt. azurestack. external , är Resource Manager-slutpunkten 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 Prenumerations-ID för den användare som gör anropet.Subscription ID of the user who makes the call.
reportedStartTime Start tid för frågan.Start time of the query. Värdet för DateTime ska vara i UTC-tid (Coordinated Universal Time) och i början av timmen, till exempel 13:00.The value for DateTime should be in Coordinated Universal Time (UTC) and at the beginning of the hour; for example, 13:00. För daglig agg regering ställer du in värdet på UTC midnatt.For daily aggregation, set this value to UTC midnight. Formatet är undantaget ISO 8601; till exempel 2015-06-16T18%3a53%3a11%2b00%3a00Z , där kolon är avbrottet %3a och plus, är avbrotts så att %2b det är URI-vänliga.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 Slut tid för frågan.End time of the query. De begränsningar som gäller gäller reportedStartTime även för det här argumentet.The constraints that apply to reportedStartTime also apply to this argument. Värdet för reportedEndTime får inte vara i framtiden eller det aktuella datumet.The value for reportedEndTime can't be either in the future, or the current date. Om så är fallet är resultatet inställt på "bearbetningen har inte slutförts".If it is, the result is set to "processing not complete."
aggregationGranularity Valfri parameter som har två diskreta möjliga värden: varje dag och varje timme.Optional parameter that has two discrete potential values: daily and hourly. I takt med att värdena föreslås returnerar en data i dags kornig het och det andra är en varje timme-lösning.As the values suggest, one returns the data in daily granularity, and the other is an hourly resolution. Alternativet varje dag är standardvärdet.The daily option is the default.
subscriberId Prenumerations-ID.Subscription ID. För att hämta filtrerade data krävs prenumerations-ID för en direkt klient organisation för providern.To get filtered data, the subscription ID of a direct tenant of the provider is required. Om ingen parameter för prenumerations-ID anges returnerar anropet användnings data för alla providerns direkta klienter.If no subscription ID parameter is specified, the call returns usage data for all the provider's direct tenants.
api-version Den version av protokollet som används för att göra denna begäran.Version of the protocol that's used to make this request. Det här värdet är inställt på 2015-06-01-preview .This value is set to 2015-06-01-preview.
continuationToken Token hämtades från det senaste anropet till API-providern för användning.Token retrieved from the last call to the usage API provider. Denna token krävs när ett svar är större än 1 000 rader.This token is needed when a response is greater than 1,000 lines. Det fungerar som ett bok märke för förloppet.It acts as a bookmark for the progress. Om token inte finns hämtas data från början av dagen eller timmen, baserat på den granularitet som har skickats in.If the token isn't present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

SvarsåtgärderResponse

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"

}
},

. . .

Svars informationResponse details

ArgumentArgument BeskrivningDescription
id Unikt ID för användnings mängden.Unique ID of the usage aggregate.
name Namnet på användnings mängden.Name of the usage aggregate.
type Resurs definition.Resource definition.
subscriptionId Prenumerations-ID för Azure Stack Hub-användaren.Subscription identifier of the Azure Stack Hub user.
usageStartTime UTC start tid för användnings Bucket som den här mängd användningen tillhör.UTC start time of the usage bucket to which this usage aggregate belongs.
usageEndTime UTC-slut tid för användnings Bucket som den här mängd användningen tillhör.UTC end time of the usage bucket to which this usage aggregate belongs.
instanceData Nyckel/värde-par med instans information (i ett nytt format):Key-value pairs of instance details (in a new format):
resourceUri: Fullständigt kvalificerat resurs-ID, som innehåller resurs grupperna och instans namnet.resourceUri: Fully qualified resource ID, which includes the resource groups and the instance name.
location: Regionen där tjänsten kördes.location: Region in which this service was run.
tags: Resurs taggar som anges av användaren.tags: Resource tags that are specified by the user.
additionalInfo: Mer information om den resurs som för bruk ATS. till exempel operativ systemets version eller avbildnings typ.additionalInfo: More details about the resource that was consumed; for example, the OS version or image type.
quantity Mängden resursförbrukning som inträffat under den här tids perioden.Amount of resource consumption that occurred in this time frame.
meterId Unikt ID för den resurs som förbrukades (kallas även ResourceID ).Unique ID for the resource that was consumed (also called ResourceID).

Hämta användnings informationRetrieve usage information

PowerShellPowerShell

Om du vill generera användnings data bör du ha resurser som kör och aktivt använder systemet. till exempel en aktiv virtuell dator (VM) eller ett lagrings konto som innehåller vissa data.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. Om du inte är säker på om du har några resurser som körs på Azure Stack hubb Marketplace, distribuerar du en virtuell dator och kontrollerar att det körs på bladet för VM-övervakning.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. Använd följande PowerShell-cmdletar för att Visa användnings data:Use the following PowerShell cmdlets to view the usage data:

  1. Installera PowerShell för Azure Stack Hub.Install PowerShell for Azure Stack Hub.

  2. Konfigurera Azure Stack Hub-användaren eller Azure Stack Hub-operatörens PowerShell-miljö.Configure the Azure Stack Hub user or the Azure Stack Hub operator PowerShell environment.

  3. Anropa PowerShell-cmdleten Get-AzsSubscriberUsage för att hämta användnings data: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

Du kan samla in användnings information för borttagna prenumerationer genom att anropa tjänsten Microsoft. Commerce. admin .You can collect usage information for deleted subscriptions by calling the Microsoft.Commerce.Admin service.

Returnera all klient användning för borttagning för aktiva användareReturn all tenant usage for deleted for active users

MetodMethod URI för förfråganRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providersMicrosoft.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 klientReturn usage for deleted or active tenant

MetodMethod URI för förfråganRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providersMicrosoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&subscriberId={subscriber-id}&api-version=2015-06-01-preview

Nästa stegNext steps