Interfejs API użycia zasobów dostawcyProvider resource usage API

Termin dostawca dotyczy administratora usługi i wszystkich delegowanych dostawców.The term provider applies to the service administrator and to any delegated providers. Operatorzy centrum Azure Stack i delegowani dostawcy mogą używać interfejsu API użycia dostawcy do wyświetlania użycia ich bezpośrednich dzierżawców.Azure Stack Hub operators and delegated providers can use the provider usage API to view the usage of their direct tenants. Na przykład, jak pokazano na poniższym diagramie, polecenie P0 może wywołać interfejs API dostawcy, aby uzyskać bezpośrednie informacje o użyciu na platformie P1 i P2, a P1 może wywoływać informacje o użyciu na stronie P3 i 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.

Model koncepcyjny hierarchii dostawcy

Odwołanie wywołania interfejsu APIAPI call reference

ŻądanieRequest

Żądanie pobiera szczegóły zużycia dla żądanych subskrypcji i dla żądanego przedziału czasu.The request gets consumption details for the requested subscriptions and for the requested time frame. Brak treści żądania.There's no request body.

Ten interfejs API użycia jest interfejsem API dostawcy, dlatego obiekt wywołujący musi mieć przypisaną rolę właściciela , współautora lub czytelnika w subskrypcji dostawcy.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 Identyfikator URI żądaniaRequest 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}

ArgumentyArguments

ArgumentArgument OpisDescription
armendpoint Azure Resource Manager punkt końcowy środowiska centrum Azure Stack.Azure Resource Manager endpoint of your Azure Stack Hub environment. Konwencja Azure Stack Hub jest taka, że nazwa punktu końcowego Azure Resource Manager ma format 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}. Na przykład dla Azure Stack Development Kit (ASDK), jeśli nazwa domeny to Local. azurestack. external , wówczas punkt końcowy Menedżer zasobów ma wartość 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 Identyfikator subskrypcji użytkownika, który wykonuje wywołanie.Subscription ID of the user who makes the call.
reportedStartTime Godzina rozpoczęcia zapytania.Start time of the query. Wartość dla DateTime powinna być w formacie UTC (Coordinated Universal Time) i na początku godziny, na przykład 13:00.The value for DateTime should be in Coordinated Universal Time (UTC) and at the beginning of the hour; for example, 13:00. W przypadku agregacji dziennej Ustaw tę wartość na czas UTC.For daily aggregation, set this value to UTC midnight. Format jest zmieniony na ISO 8601; na przykład 2015-06-16T18%3a53%3a11%2b00%3a00Z ,, gdzie znak dwukropka jest wyprowadzany, %3a i znaku plus, tak aby był %2b przyjazny dla identyfikatora 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 Godzina zakończenia zapytania.End time of the query. Ograniczenia, które dotyczą reportedStartTime również zastosowania do tego argumentu.The constraints that apply to reportedStartTime also apply to this argument. Wartość dla reportedEndTime nie może być w przyszłości ani w bieżącym dniu.The value for reportedEndTime can't be either in the future, or the current date. Jeśli tak, wynik jest ustawiany na "przetwarzanie nie zostało ukończone".If it is, the result is set to "processing not complete."
aggregationGranularity Opcjonalny parametr, który ma dwie odrębne potencjalne wartości: codziennie i co godzinę.Optional parameter that has two discrete potential values: daily and hourly. Ponieważ wartości sugerują, jedna zwraca dane w dziennej szczegółowości, a druga jest co godzinę rozdzielczością.As the values suggest, one returns the data in daily granularity, and the other is an hourly resolution. Opcja codzienne jest wartością domyślną.The daily option is the default.
subscriberId Identyfikator subskrypcji.Subscription ID. Aby uzyskać filtrowane dane, wymagany jest Identyfikator subskrypcji bezpośredniej dzierżawy dostawcy.To get filtered data, the subscription ID of a direct tenant of the provider is required. Jeśli parametr identyfikatora subskrypcji nie zostanie określony, wywołanie zwróci dane użycia dla wszystkich bezpośrednich dzierżawców dostawcy.If no subscription ID parameter is specified, the call returns usage data for all the provider's direct tenants.
api-version Wersja protokołu użyta do zgłoszenia tego żądania.Version of the protocol that's used to make this request. Ta wartość jest ustawiona na 2015-06-01-preview .This value is set to 2015-06-01-preview.
continuationToken Token pobrany z ostatniego wywołania do dostawcy interfejsu API użycia.Token retrieved from the last call to the usage API provider. Ten token jest wymagany, gdy odpowiedź jest większa niż 1 000 wierszy.This token is needed when a response is greater than 1,000 lines. Pełni rolę zakładki na potrzeby postępu.It acts as a bookmark for the progress. Jeśli token nie istnieje, dane są pobierane od początku dnia lub godziny na podstawie podanego stopnia szczegółowości.If the token isn't present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

ReakcjaResponse

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 odpowiedziResponse details

ArgumentArgument OpisDescription
id Unikatowy identyfikator agregacji użycia.Unique ID of the usage aggregate.
name Nazwa agregacji użycia.Name of the usage aggregate.
type Definicja zasobu.Resource definition.
subscriptionId Identyfikator subskrypcji użytkownika centrum Azure Stack.Subscription identifier of the Azure Stack Hub user.
usageStartTime Godzina rozpoczęcia czasu UTC przedziału użycia, do którego należy ta agregacja użycia.UTC start time of the usage bucket to which this usage aggregate belongs.
usageEndTime Godzina zakończenia czasu UTC przedziału użycia, do którego należy ta agregacja użycia.UTC end time of the usage bucket to which this usage aggregate belongs.
instanceData Pary klucz-wartość szczegółów wystąpienia (w nowym formacie):Key-value pairs of instance details (in a new format):
resourceUri: W pełni kwalifikowany identyfikator zasobu, który obejmuje grupy zasobów i nazwę wystąpienia.resourceUri: Fully qualified resource ID, which includes the resource groups and the instance name.
location: Region, w którym uruchomiono tę usługę.location: Region in which this service was run.
tags: Tagi zasobów, które są określone przez użytkownika.tags: Resource tags that are specified by the user.
additionalInfo: Więcej szczegółowych informacji na temat zasobu, który został zużyty; na przykład wersja systemu operacyjnego lub typ obrazu.additionalInfo: More details about the resource that was consumed; for example, the OS version or image type.
quantity Ilość zużywanych zasobów, która wystąpiła w tym przedziale czasowym.Amount of resource consumption that occurred in this time frame.
meterId Unikatowy identyfikator zasobu, który został zużyty (również nazywany ResourceID ).Unique ID for the resource that was consumed (also called ResourceID).

Pobierz informacje o użyciuRetrieve usage information

PowerShellPowerShell

Aby wygenerować dane dotyczące użycia, należy dysponować zasobami, które działają i aktywnie korzystają z systemu. na przykład aktywna maszyna wirtualna (VM) lub konto magazynu zawierające dane.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. Jeśli nie masz pewności, czy masz jakieś zasoby działające w witrynie Centrum Azure Stack Hub, Wdróż maszynę wirtualną, a następnie sprawdź blok monitorowanie maszyny wirtualnej, aby upewnić się, że jest uruchomiony.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. Użyj następujących poleceń cmdlet programu PowerShell, aby wyświetlić dane użycia:Use the following PowerShell cmdlets to view the usage data:

  1. Zainstaluj program PowerShell dla Azure Stack Hub.Install PowerShell for Azure Stack Hub.

  2. Skonfiguruj użytkownika centrum Azure Stack lub środowisko PowerShell centrum Azure Stack .Configure the Azure Stack Hub user or the Azure Stack Hub operator PowerShell environment.

  3. Aby pobrać dane użycia, wywołaj polecenie cmdlet Get-AzsSubscriberUsage programu PowerShell: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"
    

Interfejs API RESTREST API

Można zbierać informacje o użyciu usuniętych subskrypcji, wywołując usługę Microsoft. Commerce. Admin .You can collect usage information for deleted subscriptions by calling the Microsoft.Commerce.Admin service.

Zwróć wszystkie użycie dzierżawy dla użytkowników aktywnychReturn all tenant usage for deleted for active users

MetodaMethod Identyfikator URI żądaniaRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providersMicrosoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview

Zwróć użycie dla usuniętej lub aktywnej dzierżawyReturn usage for deleted or active tenant

MetodaMethod Identyfikator URI żądaniaRequest 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

Następne krokiNext steps