Udostępnij przez


Interfejs API wykorzystania zasobów przez dostawcę

Termin dostawca stosuje się do administratora usługi i każdego delegowanego dostawcy. Operatorzy Azure Stack Hub i delegowani dostawcy mogą używać interfejsu API użycia dostawcy do sprawdzania użycia swoich bezpośrednich najemców. Na przykład, jak pokazano na poniższym diagramie, P0 może wywołać interfejs API dostawcy w celu uzyskania bezpośrednich informacji o użyciu na P1 i P2, a P1 może wywołać informacje o użyciu na P3 i P4.

Koncepcyjny model hierarchii dostawcy

Odniesienie wywołań interfejsu API

Żądanie

Żądanie pobiera szczegóły użycia żądanych subskrypcji i dla żądanego przedziału czasu. Brak treści żądania.

Ten interfejs API użycia jest interfejsem API dostawcy, dlatego obiekt wywołujący musi mieć przypisaną rolę Właściciel, Współautor lub Czytelnik w subskrypcji dostawcy.

Metoda Żądanie URI
POBIERZ 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 (w programowaniu)

Argumentacja Opis
armendpoint Punkt końcowy usługi Azure Resource Manager środowiska usługi Azure Stack Hub. Konwencja usługi Azure Stack Hub polega na tym, że nazwa punktu końcowego usługi Azure Resource Manager ma format https://adminmanagement.{domain-name}. Na przykład w przypadku zestawu Azure Stack Development Kit (ASDK), jeśli nazwa domeny to local.azurestack.external, punkt końcowy usługi Resource Manager to https://adminmanagement.local.azurestack.external.
subId Identyfikator subskrypcji użytkownika, który wykonuje wywołanie.
reportedStartTime Godzina rozpoczęcia zapytania. Wartość parametru DateTime powinna być w uniwersalnym czasie koordynowanym (UTC) i na początku godziny, na przykład 13:00. W przypadku agregacji dziennej ustaw tę wartość na północ UTC. Format jest zapisany według normy ISO 8601; na przykład 2015-06-16T18%3a53%3a11%2b00%3a00Z, gdzie dwukropek jest zastąpiony przez %3a, a plus jest zastąpiony przez %2b, aby był przyjazny dla identyfikatora URI.
reportedEndTime Godzina zakończenia zapytania. Ograniczenia, które mają zastosowanie reportedStartTime również do tego argumentu. Wartość parametru reportedEndTime nie może być albo w przyszłości, ani bieżąca data. Jeśli tak jest, wynik jest ustawiony na "przetwarzanie nie zostało ukończone".
aggregationGranularity Opcjonalny parametr, który ma dwie odrębne wartości potencjalne: codziennie i co godzinę. Jak sugerują wartości, jeden zwraca dane z dzienną szczegółowością, a drugi z godzinową rozdzielczością. Opcja dzienna jest domyślna.
subscriberId Identyfikator subskrypcji. Aby uzyskać odfiltrowane dane, wymagany jest identyfikator subskrypcji bezpośredniej dzierżawy dostawcy. Jeśli nie określono parametru identyfikatora subskrypcji, wywołanie zwraca dane użycia dla wszystkich dzierżaw bezpośrednich dostawcy.
api-version Wersja protokołu używanego do wykonania tego żądania. Ta wartość jest ustawiona na 2015-06-01-previewwartość .
continuationToken Token pobrany z ostatniego wywołania API dostawcy danych o użyciu. Ten token jest wymagany, gdy odpowiedź jest większa niż 1000 wierszy. Działa jako zakładka postępu. Jeśli token nie jest obecny, dane są pobierane od początku dnia lub godziny na podstawie przekazanego stopnia szczegółowości.

Odpowiedź

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"

}
},

. . .

Szczegóły odpowiedzi

Argumentacja Opis
id Unikatowy identyfikator agregatu użycia.
name Nazwa agregacji użycia.
type Definicja zasobu.
subscriptionId Identyfikator subskrypcji użytkownika usługi Azure Stack Hub.
usageStartTime Godzina rozpoczęcia UTC przedziału wykorzystania, do którego należy to zbiorcze użycie.
usageEndTime Godzina zakończenia UTC segmentu użycia, do którego należy ta agregacja użycia.
instanceData Kluczowo-wartościowe pary szczegółów instancji (w nowym formacie):
resourceUri: w pełni kwalifikowany identyfikator zasobu, który zawiera grupy zasobów i nazwę wystąpienia.
location: region, w którym została uruchomiona ta usługa.
tags: Tagi zasobów określone przez użytkownika.
additionalInfo: Więcej szczegółowych informacji o zużytych zasobach; na przykład wersja systemu operacyjnego lub typ obrazu.
quantity Ilość zużycia zasobów, które wystąpiły w tym przedziale czasu.
meterId Unikatowy identyfikator zasobu, który został użyty (również nazywany ResourceID).

Pobieranie informacji o użyciu

PowerShell

Aby wygenerować dane dotyczące użycia, należy dysponować zasobami, które są uruchomione i aktywnie korzystają z systemu; na przykład aktywna maszyna wirtualna lub konto przechowywania zawierające dane. Jeśli nie masz pewności, czy masz jakiekolwiek zasoby uruchomione w Azure Stack Hub Marketplace, wdróż maszynę wirtualną i sprawdź panel monitorowania maszyny wirtualnej, aby upewnić się, że działa. Użyj następujących poleceń cmdlet programu PowerShell, aby wyświetlić dane użycia:

  1. Zainstaluj program PowerShell dla usługi Azure Stack Hub.

  2. Skonfiguruj użytkownika usługi Azure Stack Hub lub środowisko programu PowerShell operatora usługi Azure Stack Hub .

  3. Aby pobrać dane użycia, wywołaj polecenie cmdlet Get-AzsSubscriberUsage programu PowerShell:

    Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
    

Interfejs programistyczny REST

Informacje o użyciu usuniętych subskrypcji można zbierać, wywołując usługę Microsoft.Commerce.Admin .

Zwracanie całego użycia dzierżawy dla usuniętych dla aktywnych użytkowników

Metoda Żądanie URI
POBIERZ https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview

Zwracanie użycia dla usuniętego lub aktywnego klienta

Metoda Żądanie URI
POBIERZ 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

Dalsze kroki