Rozhraní API využití prostředků poskytovateleProvider resource usage API

Pojem zprostředkovatel se vztahuje na správce služeb a na všechny delegované zprostředkovatele.The term provider applies to the service administrator and to any delegated providers. Operátory centra Azure Stack a delegovaní zprostředkovatelé můžou používat rozhraní API Využití poskytovatele k zobrazení využití jejich přímých klientů.Azure Stack Hub operators and delegated providers can use the provider usage API to view the usage of their direct tenants. Například, jak je znázorněno v následujícím diagramu, P0 může zavolat rozhraní API zprostředkovatele, aby získal informace o přímých použitích P1 a P2 a P1 může volat informace o použití na P3 a 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.

Koncepční model hierarchie zprostředkovatele

Reference k volání rozhraní APIAPI call reference

ŽádostRequest

Požadavek získá podrobnosti o spotřebě pro požadovaná předplatná a pro požadovaný časový rámec.The request gets consumption details for the requested subscriptions and for the requested time frame. Tělo žádosti není k dispozici.There's no request body.

Toto rozhraní API pro použití je poskytovatele API, takže volajícímu musí být v předplatném poskytovatele přiřazená role vlastník , Přispěvatel nebo Čtenář .This usage API is a provider API, so the caller must be assigned an Owner , Contributor , or Reader role in the provider's subscription.

MetodaMethod Identifikátor URI žádostiRequest 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}

ArgumentsArguments

ArgumentArgument PopisDescription
armendpoint Azure Resource Manager koncový bod vašeho prostředí centra Azure Stack.Azure Resource Manager endpoint of your Azure Stack Hub environment. Azure Stack konvence centra je název koncového bodu Azure Resource Manager ve formátu 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}. Například pro Azure Stack Development Kit (ASDK), pokud je název domény Local. azurestack. external , pak je koncový bod správce prostředků 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 ID předplatného uživatele, který provádí volání.Subscription ID of the user who makes the call.
reportedStartTime Počáteční čas dotazu.Start time of the query. Hodnota pro DateTime by měla být v koordinovaném světovým čase (UTC) a na začátku hodiny, například 13:00.The value for DateTime should be in Coordinated Universal Time (UTC) and at the beginning of the hour; for example, 13:00. U denní agregace nastavte tuto hodnotu na půlnoc UTC.For daily aggregation, set this value to UTC midnight. Formát je řídicí. ISO 8601; Například, v 2015-06-16T18%3a53%3a11%2b00%3a00Z případě, že dvojtečka je uvozena na %3a a znaménkem plus je uvozena tak, aby byla přičtena k %2b identifikátoru URI.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 Koncový čas dotazu.End time of the query. U tohoto argumentu platí i omezení, která platí pro reportedStartTime .The constraints that apply to reportedStartTime also apply to this argument. Hodnota pro reportedEndTime nemůže být v budoucnosti nebo aktuální datum.The value for reportedEndTime can't be either in the future, or the current date. Pokud je, výsledek je nastaven na "zpracování není dokončeno".If it is, the result is set to "processing not complete."
aggregationGranularity Volitelný parametr, který má dvě diskrétní možné hodnoty: denně a každou hodinu.Optional parameter that has two discrete potential values: daily and hourly. Vzhledem k tomu, že hodnoty naznačují, vrátí jedna data v denní členitosti a druhá je hodinové řešení.As the values suggest, one returns the data in daily granularity, and the other is an hourly resolution. Možnost denní je výchozí hodnota.The daily option is the default.
subscriberId ID předplatného.Subscription ID. Aby bylo možné získat filtrovaná data, je požadováno ID předplatného přímého tenanta poskytovatele.To get filtered data, the subscription ID of a direct tenant of the provider is required. Pokud není zadán parametr ID předplatného, volání vrátí data o využití pro všechny přímé klienty poskytovatele.If no subscription ID parameter is specified, the call returns usage data for all the provider's direct tenants.
api-version Verze protokolu, který se používá k provedení tohoto požadavku.Version of the protocol that's used to make this request. Tato hodnota je nastavena na 2015-06-01-preview .This value is set to 2015-06-01-preview.
continuationToken Token načtený z posledního volání poskytovatele rozhraní API využitíToken retrieved from the last call to the usage API provider. Tento token je nutný, pokud je odpověď větší než 1 000 řádků.This token is needed when a response is greater than 1,000 lines. Slouží jako záložka pro průběh.It acts as a bookmark for the progress. Pokud token není k dispozici, data se načítají od začátku dne nebo hodiny na základě předané členitosti.If the token isn't present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

OdpověďResponse

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"

}
},

. . .

Podrobnosti odpovědiResponse details

ArgumentArgument PopisDescription
id Jedinečné ID agregace využitíUnique ID of the usage aggregate.
name Název agregace použitíName of the usage aggregate.
type Definice prostředků.Resource definition.
subscriptionId Identifikátor předplatného uživatele centra Azure Stack.Subscription identifier of the Azure Stack Hub user.
usageStartTime Čas spuštění v čase UTC sady, do které patří agregace tohoto využití.UTC start time of the usage bucket to which this usage aggregate belongs.
usageEndTime Čas ukončení UTC intervalu použití, do kterého patří agregace tohoto využití.UTC end time of the usage bucket to which this usage aggregate belongs.
instanceData Páry klíč-hodnota podrobností instance (v novém formátu):Key-value pairs of instance details (in a new format):
resourceUri: Plně kvalifikované ID prostředku, které zahrnuje skupiny prostředků a název instance.resourceUri: Fully qualified resource ID, which includes the resource groups and the instance name.
location: Oblast, ve které byla tato služba spuštěna.location: Region in which this service was run.
tags: Značky prostředků, které jsou určeny uživatelem.tags: Resource tags that are specified by the user.
additionalInfo: Další podrobnosti o spotřebovaném prostředku; například verze operačního systému nebo typ obrázku.additionalInfo: More details about the resource that was consumed; for example, the OS version or image type.
quantity Množství spotřeby prostředků, ke kterým došlo v tomto časovém rámci.Amount of resource consumption that occurred in this time frame.
meterId Jedinečné ID prostředku, který byl spotřebován (označovaný také jako ResourceID ).Unique ID for the resource that was consumed (also called ResourceID).

Načíst informace o použitíRetrieve usage information

PowerShellPowerShell

Pokud chcete vygenerovat data o využití, měli byste mít prostředky, na kterých běží a aktivně používají systém. Například aktivní virtuální počítač (VM) nebo účet úložiště obsahující 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. Pokud si nejste jistí, jestli máte nějaké prostředky spuštěné v tržišti centra Azure Stack, nasaďte virtuální počítač a ověřte okno monitorování virtuálního počítače, abyste se ujistili, že je spuštěný.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. K zobrazení dat o využití použijte následující rutiny PowerShellu:Use the following PowerShell cmdlets to view the usage data:

  1. Nainstalujte PowerShell pro centrum Azure Stack.Install PowerShell for Azure Stack Hub.

  2. Nakonfigurujte Azure Stackho uživatele centra nebo prostředí PowerShell pro operátor centra Azure Stack .Configure the Azure Stack Hub user or the Azure Stack Hub operator PowerShell environment.

  3. Pokud chcete načíst data o využití, zavolejte rutinu PowerShellu Get-AzsSubscriberUsage :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

Informace o použití pro odstraněné odběry můžete shromažďovat voláním služby Microsoft. Commerce. admin .You can collect usage information for deleted subscriptions by calling the Microsoft.Commerce.Admin service.

Vrátí všechny využití tenanta pro odstraněné aktivní uživatele.Return all tenant usage for deleted for active users

MetodaMethod Identifikátor URI žádostiRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providersMicrosoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview

Vrátit využití pro odstraněné nebo aktivní tenantaReturn usage for deleted or active tenant

MetodaMethod Identifikátor URI žádostiRequest 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

Další krokyNext steps