Resourcegebruik-API voor providersProvider resource usage API

De provider van de term is van toepassing op de service beheerder en op alle gedelegeerde providers.The term provider applies to the service administrator and to any delegated providers. Azure Stack hub-Opera tors en gedelegeerde providers kunnen gebruikmaken van de API voor het gebruik van de provider om het gebruik van hun directe tenants weer te geven.Azure Stack Hub operators and delegated providers can use the provider usage API to view the usage of their direct tenants. Zo kan P0, zoals weer gegeven in het volgende diagram, de provider-API aanroepen om informatie over direct gebruik op P1 en P2 te verkrijgen, en P1 kan informatie over gebruik aanroepen op P3 en 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.

Conceptueel model van de provider hiƫrarchie

Naslag informatie over API-aanroepenAPI call reference

AanvraagRequest

De aanvraag ontvangt Details van het verbruik voor de aangevraagde abonnementen en voor het aangevraagde tijds bestek.The request gets consumption details for the requested subscriptions and for the requested time frame. Er is geen aanvraag tekst.There's no request body.

Deze gebruiks-API is een provider-API. Daarom moet aan de aanroeper een rol van eigenaar , bijdrager of lezer worden toegewezen in het abonnement van de provider.This usage API is a provider API, so the caller must be assigned an Owner , Contributor , or Reader role in the provider's subscription.

MethodeMethod Aanvraag-URIRequest 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}

ArgumentenArguments

ArgumentArgument BeschrijvingDescription
armendpoint Azure Resource Manager-eind punt van uw Azure Stack hub-omgeving.Azure Resource Manager endpoint of your Azure Stack Hub environment. De Azure Stack hub-Conventie is dat de naam van het Azure Resource Manager-eind punt de indeling heeft 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}. Bijvoorbeeld: voor de Azure Stack Development Kit (ASDK), als de domein naam lokaal. azurestack. external is, is het Resource Manager-eind punt 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 De abonnements-ID van de gebruiker die de aanroep doet.Subscription ID of the user who makes the call.
reportedStartTime Begin tijd van de query.Start time of the query. De waarde voor DateTime moet worden uitgedrukt in Coordinated Universal Time (UTC) en aan het begin van het uur, bijvoorbeeld 13:00.The value for DateTime should be in Coordinated Universal Time (UTC) and at the beginning of the hour; for example, 13:00. Voor dagelijkse aggregatie stelt u deze waarde in op UTC middernacht.For daily aggregation, set this value to UTC midnight. De indeling is ISO 8601-Escapes. bijvoorbeeld, 2015-06-16T18%3a53%3a11%2b00%3a00Z waarbij de dubbele punt wordt geescapet %3a en het plus teken wordt naar de %2b URI-vriendelijk geescapet.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 Eind tijd van de query.End time of the query. De beperkingen die van toepassing zijn op gelden reportedStartTime ook voor dit argument.The constraints that apply to reportedStartTime also apply to this argument. De waarde voor reportedEndTime kan niet in de toekomst of op de huidige datum zijn.The value for reportedEndTime can't be either in the future, or the current date. Als dat het geval is, wordt het resultaat ingesteld op ' verwerking niet voltooid '.If it is, the result is set to "processing not complete."
aggregationGranularity Optionele para meter met twee discrete mogelijke waarden: dagelijks en elk uur.Optional parameter that has two discrete potential values: daily and hourly. Zoals de waarden Voorst Ellen, worden de gegevens in de dagelijkse granulatie geretourneerd en de andere is een resolutie van een uur.As the values suggest, one returns the data in daily granularity, and the other is an hourly resolution. De optie dagelijks is de standaard instelling.The daily option is the default.
subscriberId Abonnements-ID.Subscription ID. Als u gefilterde gegevens wilt ophalen, is de abonnements-ID van een directe Tenant van de provider vereist.To get filtered data, the subscription ID of a direct tenant of the provider is required. Als er geen para meter voor de abonnements-ID is opgegeven, retourneert de aanroep gebruiks gegevens voor alle directe tenants van de provider.If no subscription ID parameter is specified, the call returns usage data for all the provider's direct tenants.
api-version De versie van het protocol dat wordt gebruikt om deze aanvraag uit te voeren.Version of the protocol that's used to make this request. Deze waarde is ingesteld op 2015-06-01-preview .This value is set to 2015-06-01-preview.
continuationToken Het token is opgehaald van de laatste aanroep naar de Usage API-provider.Token retrieved from the last call to the usage API provider. Dit token is vereist wanneer een reactie groter is dan 1.000 regels.This token is needed when a response is greater than 1,000 lines. De functie fungeert als blad wijzer voor de voortgang.It acts as a bookmark for the progress. Als het token niet aanwezig is, worden de gegevens opgehaald vanaf het begin van de dag of het uur, op basis van de granulatie die is door gegeven.If the token isn't present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

AntwoordResponse

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"

}
},

. . .

Antwoord DetailsResponse details

ArgumentArgument BeschrijvingDescription
id De unieke ID van het gebruik van de statistische functie.Unique ID of the usage aggregate.
name De naam van het gebruik van de statistische functie.Name of the usage aggregate.
type Resource definitie.Resource definition.
subscriptionId De abonnements-id van de gebruiker van de Azure Stack hub.Subscription identifier of the Azure Stack Hub user.
usageStartTime De UTC-begin tijd van de Bucket met deze statistische functie behoort tot het gebruik.UTC start time of the usage bucket to which this usage aggregate belongs.
usageEndTime De UTC-eind tijd van de Bucket van het gebruik waartoe deze statistische verzameling behoort.UTC end time of the usage bucket to which this usage aggregate belongs.
instanceData Sleutel-waardeparen van exemplaar Details (in een nieuwe indeling):Key-value pairs of instance details (in a new format):
resourceUri: Volledig gekwalificeerde Resource-ID, die de resource groepen en de naam van het exemplaar bevat.resourceUri: Fully qualified resource ID, which includes the resource groups and the instance name.
location: De regio waarin deze service is uitgevoerd.location: Region in which this service was run.
tags: Resource Tags die zijn opgegeven door de gebruiker.tags: Resource tags that are specified by the user.
additionalInfo: Meer informatie over de resource die is verbruikt. bijvoorbeeld de versie van het besturings systeem of het type installatie kopie.additionalInfo: More details about the resource that was consumed; for example, the OS version or image type.
quantity De hoeveelheid Resource verbruik die in deze tijds periode is opgetreden.Amount of resource consumption that occurred in this time frame.
meterId De unieke ID voor de resource die is verbruikt (ook wel genoemd ResourceID ).Unique ID for the resource that was consumed (also called ResourceID).

Informatie over het gebruik ophalenRetrieve usage information

PowerShellPowerShell

Als u de gebruiks gegevens wilt genereren, moet u resources hebben met en actief gebruikmaken van het systeem. bijvoorbeeld een actieve virtuele machine (VM) of een opslag account met een aantal gegevens.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. Als u niet zeker weet of u resources hebt die worden uitgevoerd in de Azure Stack hub Marketplace, implementeert u een virtuele machine en controleert u de Blade VM-controle om te controleren of deze wordt uitgevoerd.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. Gebruik de volgende Power shell-cmdlets om de gebruiks gegevens weer te geven:Use the following PowerShell cmdlets to view the usage data:

  1. Power shell voor Azure stack hub installeren.Install PowerShell for Azure Stack Hub.

  2. Configureer de Azure stack hub-gebruiker of de Power shell-omgeving van de Azure stack hub-operator .Configure the Azure Stack Hub user or the Azure Stack Hub operator PowerShell environment.

  3. Als u de gebruiks gegevens wilt ophalen, roept u de Power shell -cmdlet Get-AzsSubscriberUsage aan: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

U kunt gebruiks gegevens voor verwijderde abonnementen verzamelen door de service micro soft. commerce. admin aan te roepen.You can collect usage information for deleted subscriptions by calling the Microsoft.Commerce.Admin service.

Het gebruik van alle tenants voor verwijderde voor actieve gebruikers retour nerenReturn all tenant usage for deleted for active users

MethodeMethod Aanvraag-URIRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providersMicrosoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview

Het gebruik van een verwijderde of actieve Tenant retour nerenReturn usage for deleted or active tenant

MethodeMethod Aanvraag-URIRequest 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

Volgende stappenNext steps