Interfejs API użycia zasobów dostawcy

  • Artykuł

Termin dostawca ma zastosowanie do administratora usługi i do wszystkich delegowanych dostawców. Operatorzy usługi Azure Stack Hub i dostawcy delegowani mogą używać interfejsu API użycia dostawcy do wyświetlania użycia ich bezpośrednich dzierżaw. 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 w P3 i P4.

Model koncepcyjny hierarchii dostawcy

Dokumentacja wywołań interfejsu API

Żądanie

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

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

Metoda Identyfikator URI żądania
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 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, Resource Manager punkt końcowy 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 ucieczki ISO 8601; na przykład , 2015-06-16T18%3a53%3a11%2b00%3a00Zgdzie dwukropek jest uciekany do %3a , a znak plus jest uciekany, %2b aby był przyjazny dla identyfikatora URI.
reportedEndTime Godzina zakończenia zapytania. Ograniczenia, które mają reportedStartTime zastosowanie 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 dyskretne potencjalne wartości: codziennie i co godzinę. Jak sugerują wartości, jeden zwraca dane w dziennym stopnia szczegółowości, a drugi jest godzinowym rozwiązaniem. 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 bezpośrednich dzierżaw 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 dostawcy interfejsu API użycia. 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 stopnia szczegółowości przekazanego.

Reakcja

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

Argument Opis
id Unikatowy identyfikator agregacji 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 zasobnika użycia, do którego należy ta agregacja użycia.
usageEndTime Godzina zakończenia czasu UTC zasobnika użycia, do którego należy ta agregacja użycia.
instanceData Pary klucz-wartość szczegółów wystąpienia (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 uruchomiono tę usługę.
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ść użycia zasobów, które wystąpiły w tym przedziale czasu.
meterId Unikatowy identyfikator zasobu, który został użyty (nazywany ResourceIDrównież ).

Pobieranie informacji o użyciu

PowerShell

Aby wygenerować dane użycia, należy mieć zasoby, które są uruchomione i aktywnie korzystają z systemu; na przykład aktywna maszyna wirtualna lub konto magazynu zawierające dane. Jeśli nie masz pewności, czy masz jakiekolwiek zasoby uruchomione w witrynie Azure Stack Hub Marketplace, wdróż maszynę wirtualną i sprawdź blok monitorowania maszyny wirtualnej, aby upewnić się, że jest uruchomiony. 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 API REST

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

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

Metoda Identyfikator URI żądania
GET 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ętej lub aktywnej dzierżawy

Metoda Identyfikator URI żądania
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

Następne kroki