Rozhraní API pro využití zdrojů poskytovatele
Termín poskytovatel se vztahuje na správce služeb a na všechny delegovaného poskytovatele. Operátoři služby Azure Stack Hub a delegovaní poskytovatelé můžou pomocí rozhraní API využití poskytovatele zobrazit využití jejich přímých tenantů. Například jak je znázorněno v následujícím diagramu, P0 může volat rozhraní API poskytovatele, aby získalo informace o přímém využití na P1 a P2 a P1 může volat informace o využití na P3 a P4.
Referenční informace k volání rozhraní API
Prosba
Žádost získá podrobnosti o spotřebě požadovaných předplatných a pro požadovaný časový rámec. Neexistuje žádný text požadavku.
Toto rozhraní API pro využití je rozhraní API poskytovatele, takže volajícímu musí být přiřazena role Vlastníka, Přispěvatelenebo Čtenáře v předplatném poskytovatele.
| Metoda | Identifikátor URI požadavku |
|---|---|
| ZÍSKAT | 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
| Argumentace | Popis |
|---|---|
armendpoint |
Koncový bod Azure Resource Manageru vašeho prostředí služby Azure Stack Hub. Konvence služby Azure Stack Hub je, že název koncového bodu Azure Resource Manageru je ve formátu https://adminmanagement.{domain-name}. Například pro sadu Azure Stack Development Kit (ASDK), pokud je název domény local.azurestack.external, koncový bod Resource Manageru je https://adminmanagement.local.azurestack.external. |
subId |
ID předplatného uživatele, který hovor provede. |
reportedStartTime |
Počáteční čas dotazu. Hodnota pro DateTime by 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 escapovaný ISO 8601; například 2015-06-16T18%3a53%3a11%2b00%3a00Z, kde dvojtečka je escapována na %3a a plus je escapováno na %2b, aby byl kompatibilní s URI. |
reportedEndTime |
Koncový čas dotazu. Omezení, která platí pro reportedStartTime platí také pro tento argument. Hodnota pro reportedEndTime nemůže být ani v budoucnu, ani současné datum. Pokud ano, je výsledek nastavený na "zpracování není dokončeno". |
aggregationGranularity |
Volitelný parametr, který má dvě diskrétní potenciální hodnoty: denní a hodinově. Jak napovídají hodnoty, jedna vrátí data v denní členitosti a druhá v hodinovém rozlišení. Denní volba je výchozí 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 nastavena na 2015-06-01-preview. |
continuationToken |
Token načtený z posledního volání poskytovatele API použití Tento token je potřeba, pokud je odpověď větší než 1 000 řádků. Slouží jako záložka pro průběh procesu. Pokud token není k dispozici, data se načtou od začátku dne nebo hodiny podle předané úrovně podrobnosti. |
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ý identifikátor agregace využití |
name |
Název agregace využití |
type |
Definice zdroje |
subscriptionId |
Identifikátor předplatného uživatele služby Azure Stack Hub. |
usageStartTime |
Čas zahájení UTC kontejneru využití, do kterého patří tato agregace využití. |
usageEndTime |
Koncový čas UTC kontejneru využití, do kterého patří tato agregace využití. |
instanceData |
Podrobnosti instance jako páry klíč-hodnota (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ů určené 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ým došlo v tomto časovém rámci. |
meterId |
Jedinečné ID spotřebovaného prostředku (označovaného také jako ResourceID). |
Načtěte informace o využití
PowerShell
Pokud chcete vygenerovat data o využití, měli byste mít prostředky, které jsou spuštěné a aktivně využívají systém; Například aktivní virtuální počítač nebo účet úložiště obsahující některá data. Pokud si nejste jisti, zda na Azure Stack Hub Marketplace máte spuštěné nějaké prostředky, vytvořte virtuální počítač a zkontrolujte monitorovací okno virtuálního počítače, abyste se ujistili, že je spuštěný. K zobrazení dat o využití použijte následující rutiny PowerShellu:
Nakonfigurujte uživatele nebo operátora služby Azure Stack Hubprostředí PowerShell.
Chcete-li načíst data o využití, použijte rutinu PowerShell Get-AzsSubscriberUsage.
Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
REST API
Informace o využití pro odstraněná předplatná můžete shromažďovat voláním služby Microsoft.Commerce.Admin.
Vrácení veškerého využití tenanta pro odstraněné aktivní uživatele
| Metoda | Požadavek URI |
|---|---|
| ZÍSKAT | 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 nájemníka
| Metoda | Požadavek na URI |
|---|---|
| DOSTAT | 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 |