Rozhraní API využití prostředků poskytovatele
Termín poskytovatel se vztahuje na správce služby a na všechny delegovaní poskytovatelé. Operátoři a delegovaní poskytovatelé služby Azure Stack Hub můžou pomocí rozhraní API pro využití zprostředkovatele zobrazit využití svých přímých tenantů. Například, jak je znázorněno na následujícím diagramu, P0 může volat rozhraní API poskytovatele, aby získalo informace o přímém využití pro P1 a P2, a P1 může volat informace o využití pro P3 a P4.
Referenční informace k volání rozhraní API
Žádost
Žádost získá podrobnosti o spotřebě požadovaných předplatných a požadovaného časového rámce. Neexistuje žádný text požadavku.
Toto rozhraní API pro využití je rozhraní API poskytovatele, takže volajícímu musí být v předplatném poskytovatele přiřazena role Vlastník, Přispěvatel nebo Čtenář .
| Metoda | Identifikátor URI žádosti |
|---|---|
| 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} |
Argumenty
| Argument | Popis |
|---|---|
armendpoint |
Koncový bod Azure Resource Manager prostředí Služby Azure Stack Hub. Konvence služby Azure Stack Hub je, že název koncového bodu Azure Resource Manager je ve formátu https://adminmanagement.{domain-name}. Pokud je například pro sadu Azure Stack Development Kit (ASDK) název domény local.azurestack.external, koncový bod Resource Manager je https://adminmanagement.local.azurestack.external. |
subId |
ID předplatného uživatele, který provádí hovor. |
reportedStartTime |
Čas zahájení dotazu. Hodnota by DateTime měla být v koordinovaném univerzálním čase (UTC) a na začátku hodiny, například 13:00. Pro denní agregaci nastavte tuto hodnotu na půlnoc UTC. Formát je uniká iso 8601; Například 2015-06-16T18%3a53%3a11%2b00%3a00Z, kde se dvojtečka uchytá do %3a a hodnota plus je utekaná na, aby byla vhodná pro %2b identifikátor URI. |
reportedEndTime |
Koncový čas dotazu. Omezení, která platí pro reportedStartTime tento argument, platí také pro tento argument. Hodnota pro reportedEndTime nemůže být buď v budoucnosti, ani aktuální datum. Pokud ano, výsledek je nastavený na "zpracování není dokončeno". |
aggregationGranularity |
Volitelný parametr, který má dvě diskrétní potenciální hodnoty: denní a hodinovou. Jak naznačují hodnoty, jeden vrací data v denním členitosti a druhý je hodinový rozlišení. Výchozí je denní možnost. |
subscriberId |
ID předplatného K získání filtrovaných dat se vyžaduje ID předplatného přímého tenanta poskytovatele. Pokud není zadán žádný parametr ID předplatného, volání vrátí data o využití pro všechny přímé tenanty poskytovatele. |
api-version |
Verze protokolu, který se používá k provedení tohoto požadavku. Tato hodnota je nastavená na 2015-06-01-preview. |
continuationToken |
Token načtený z posledního volání zprostředkovatele rozhraní API pro využití. Tento token je potřeba, pokud je odpověď větší než 1 000 řádků. Funguje jako záložka pro průběh. Pokud token neexistuje, data se načítají od začátku dne nebo hodiny na základě předané členitosti. |
Odpověď
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ědi
| Argument | Popis |
|---|---|
id |
Jedinečné ID agregace využití |
name |
Název agregace využití |
type |
Definice prostředku. |
subscriptionId |
Identifikátor předplatného uživatele služby Azure Stack Hub. |
usageStartTime |
Počáteční čas (UTC) kbelíku využití, do kterého tato agregace využití patří. |
usageEndTime |
Koncový čas (UTC) kontejneru využití, do kterého tato agregace využití patří. |
instanceData |
Páry klíč-hodnota podrobností instance (v novém formátu):resourceUri: Plně kvalifikované ID prostředku, které zahrnuje skupiny prostředků a název instance. location: Oblast, ve které byla tato služba spuštěna. tags: Značky prostředků zadané uživatelem. additionalInfo: Další podrobnosti o spotřebovaném prostředku; například verze operačního systému nebo typ image. |
quantity |
Množství spotřeby prostředků, ke které došlo v tomto časovém rámci. |
meterId |
Jedinečné ID prostředku, který byl spotřebován (označuje se také jako ResourceID). |
Načtení informací o využití
PowerShell
Chcete-li generovat data o využití, měli byste mít prostředky, které jsou spuštěny a aktivně používají systém. Například aktivní virtuální počítač nebo účet úložiště obsahující určitá data. Pokud si nejste jistí, jestli máte na Marketplace služby Azure Stack Hub spuštěné nějaké prostředky, nasaďte virtuální počítač a ověřte okno monitorování virtuálních počítačů, abyste měli jistotu, že je spuštěný. K zobrazení dat o využití použijte následující rutiny PowerShellu:
Nakonfigurujte uživatele služby Azure Stack Hub nebo prostředí PowerShellu operátora služby Azure Stack Hub .
Pokud chcete načíst data o využití, zavolejte rutinu PowerShellu Get-AzsSubscriberUsage :
Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
REST API
Informace o využití odstraněných předplatných můžete shromažďovat voláním služby Microsoft.Commerce.Správa.
Vrácení veškerého využití tenanta pro odstraněné aktivní uživatele
| Metoda | Identifikátor URI žádosti |
|---|---|
| GET | https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview |
Vrácení využití pro odstraněného nebo aktivního tenanta
| Metoda | Identifikátor URI žádosti |
|---|---|
| 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 |