Freigeben über


Anbieterressourcenverwendungs-API

Der Begriffsanbieter gilt für den Dienstadministrator und für alle delegierten Anbieter. Azure Stack Hub-Operatoren und delegierte Anbieter können die Anbieterverwendungs-API verwenden, um die Verwendung ihrer direkten Mandanten anzuzeigen. Wie im folgenden Diagramm dargestellt, kann P0 beispielsweise die Anbieter-API aufrufen, um Informationen zur direkten Nutzung von P1 und P2 abzurufen, und P1 kann die Nutzungsinformationen von P3 und P4 abrufen.

Konzeptionelles Modell der Anbieterhierarchie

API-Aufrufreferenz

Anfrage

Die Anforderung ruft detaillierte Nutzungsinformationen für das angeforderte Abonnement und den angeforderten Zeitraum ab. Es gibt keinen Anforderungstext.

Diese Verwendungs-API ist eine Anbieter-API, sodass dem Aufrufer eine Rolle "Besitzer", "Mitwirkender" oder "Reader " im Abonnement des Anbieters zugewiesen werden muss.

Methode Anforderungs-URI
ERHALTEN/Bekommen 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}

Argumente

Streitpunkt BESCHREIBUNG
armendpoint Azure Resource Manager-Endpunkt Ihrer Azure Stack Hub-Umgebung. Nach Azure Stack Hub-Konvention folgt der Name des Azure Resource Manager-Endpunkts dem Format https://adminmanagement.{domain-name}. For example, for the Azure Stack Development Kit (ASDK), if the domain name is local.azurestack.external, the Resource Manager endpoint is https://adminmanagement.local.azurestack.external.
subId Abonnement-ID des Benutzers, von dem der Aufruf ausgeht.
reportedStartTime Die Startzeit der Abfrage. Der Wert für DateTime sollte in koordinierter Weltzeit (UTC) und vollen Stunden angegeben werden, z. B. 13:00. Legen Sie den Wert für eine tägliche Aggregation auf Mitternacht (UTC) fest. Das Format ist escaped ISO 8601; Beispiel: 2015-06-16T18%3a53%3a11%2b00%3a00ZWenn der Doppelpunkt escaped %3a ist und das Pluszeichen so escaped %2b ist, dass er URI-freundlich ist.
reportedEndTime Die Endzeit der Abfrage. Die Einschränkungen, die für reportedStartTime gelten, gelten auch für dieses Argument. Der Wert von reportedEndTime darf nicht in der Zukunft liegen oder das aktuelle Datum sein. Wenn dies der Fall ist, wird als Ergebnis „processing not complete“ (nicht abgeschlossen) angezeigt.
aggregationGranularity Optionaler Parameter, der zwei mögliche diskrete Werte hat: täglich und stündlich. Wie die Namen schon sagen, gibt der eine Wert Daten in Abständen von einem Tag zurück und der andere in Abständen von einer Stunde. Der Standard ist die Option täglich.
subscriberId Abonnement-ID Um gefilterte Daten zu erhalten, ist die Abonnement-ID eines direkten Mandanten des Anbieters erforderlich. Wenn kein Parameter für die Abonnement-ID angegeben ist, gibt der Aufruf Nutzungsdaten für alle direkten Mandanten des Anbieters zurück.
api-version Die Version des Protokolls, das für diese Anforderung verwendet wird. Dieser Wert ist auf 2015-06-01-preview festgelegt.
continuationToken Das Token, das durch den letzten Aufruf des Anbieters der Nutzungs-API abgerufen wurde. Dieses Token ist erforderlich, wenn eine Antwort länger als 1.000 Zeilen ist. Es fungiert als Lesezeichen für den Status. Falls das Token nicht vorhanden ist, werden die Daten auf Grundlage der übergebenen Granularität vom Anfang des Tages oder der Stunde abgerufen.

Antwort

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"

}
},

. . .

Details der Antwort

Streitpunkt BESCHREIBUNG
id Eindeutige ID des Nutzungsaggregats.
name Name des Nutzungsaggregats.
type Ressourcendefinition.
subscriptionId Bezeichner des Abonnements des Azure Stack Hub-Benutzers.
usageStartTime Startzeit (UTC) des Nutzungsbuckets, zu dem dieses Nutzungsaggregat gehört.
usageEndTime Endzeit (UTC) des Nutzungsbuckets, zu dem dieses Nutzungsaggregat gehört.
instanceData Schlüssel-Wert-Paare der genaueren Angaben zu der Instanz (in neuem Format):
resourceUri: Vollqualifizierte Ressourcen-ID, die die Ressourcengruppen und den Instanznamen enthält.
location: Region, in der der Dienst ausgeführt wurde.
tags: Ressourcentags, die vom Benutzer angegeben werden.
additionalInfo: Weitere Angaben zur genutzten Ressource, z.B. die Betriebssystemversion oder der Imagetyp.
quantity Menge der Ressourcennutzung, die in diesem Zeitraum aufgetreten ist.
meterId Eindeutige ID für die Ressource, die verbraucht wurde (auch aufgerufen ResourceID).

Abrufen von Nutzungsinformationen

PowerShell

Um die Nutzungsdaten zu generieren, sollten Sie Über Ressourcen verfügen, die ausgeführt und aktiv das System verwenden. Beispielsweise ein aktiver virtueller Computer (VM) oder ein Speicherkonto, das einige Daten enthält. Wenn Sie nicht sicher sind, ob Im Azure Stack Hub Marketplace Ressourcen ausgeführt werden, stellen Sie einen virtuellen Computer bereit, und überprüfen Sie das Blatt für die VM-Überwachung, um sicherzustellen, dass sie ausgeführt wird. Verwenden Sie die folgenden PowerShell-Cmdlets, um die Nutzungsdaten anzuzeigen:

  1. Installieren von PowerShell für Azure Stack Hub

  2. Konfigurieren Sie den Azure Stack Hub-Benutzer oder die PowerShell-Umgebung des Azure Stack Hub-Operators .

  3. Rufen Sie zum Abrufen der Nutzungsdaten das PowerShell-Cmdlet Get-AzsSubscriberUsage ab:

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

REST-API

Sie können Nutzungsinformationen für gelöschte Abonnements sammeln, indem Sie den Microsoft.Commerce.Admin-Dienst aufrufen.

Gibt alle Mandantennutzung für aktive Benutzer zurück.

Methode Anforderungs-URI
ERHALTEN/Bekommen https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview

Zurückgeben der Verwendung für gelöschte oder aktive Mandanten

Methode Anforderungs-URI
ERHALTEN/Bekommen 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

Nächste Schritte