Informazioni di riferimento sull'API per l'utilizzo delle risorse tenant

  • Articolo

Un tenant può usare le API tenant per visualizzare i dati di utilizzo delle risorse del tenant. Queste API sono coerenti con le API di utilizzo di Azure.

È possibile usare il cmdlet Get-UsageAggregates Windows PowerShell per ottenere i dati di utilizzo, proprio come in Azure.

Chiamata API

Richiesta

La richiesta ottiene i dettagli sull'utilizzo per le sottoscrizioni richieste e per l'intervallo di tempo richiesto. Non esiste alcun corpo della richiesta.

Metodo URI richiesta
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportEndTime={reportedEndTime}&aggregazioneGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Parametri

Parametro Descrizione
Armendpoint Endpoint di Azure Resource Manager dell'ambiente dell'hub di Azure Stack. La convenzione dell'hub di Azure Stack è che il nome dell'endpoint di Azure Resource Manager è nel formato https://management.{domain-name}. Ad esempio, per il kit di sviluppo, il nome di dominio è local.azurestack.external, quindi l'endpoint di Resource Manager è https://management.local.azurestack.external.
subId ID sottoscrizione dell'utente che effettua la chiamata. È possibile usare questa API solo per eseguire query sull'utilizzo di una singola sottoscrizione. I provider possono usare l'API di utilizzo delle risorse del provider per eseguire query sull'utilizzo per tutti i tenant.
reportedStartTime Ora di inizio della query. Il valore per DateTime deve essere in formato UTC e all'inizio dell'ora; ad esempio, 13:00. Per l'aggregazione giornaliera, impostare questo valore su mezzanotte ora UTC. Il formato è escape ISO 8601; ad esempio, 2015-06-16T18%3a53%3a11%2b00%3a00Z, dove i due punti vengono escape a %3a e più vengono escape a %2b in modo che sia descrittivo l'URI.
reportEndTime Ora di fine della query. I vincoli che si applicano a reportStartTime si applicano anche a questo parametro. Il valore per reportEndTime non può essere in futuro.
aggregazioneGranularità Parametro facoltativo con due valori potenziali discreti: giornaliero e oraria. Come suggerito dai valori, uno restituisce i dati nella granularità giornaliera e l'altro è una risoluzione oraria. L'opzione giornaliera è l'impostazione predefinita.
api-version Versione del protocollo usato per effettuare questa richiesta. È necessario usare 2015-06-01-preview.
continuationToken Token recuperato dall'ultima chiamata al provider dell'API di utilizzo. Questo token è necessario quando una risposta contiene più di 1.000 righe. Funge da segnalibro per lo stato di avanzamento. Se non presente, i dati vengono recuperati dall'inizio del giorno o dell'ora, in base alla granularità passata.

Risposta

GET
/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&api-version=1.0

{
"value": [
{

"id":
"/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregate/sub1-meterID1",
"name": "sub1-meterID1",
"type": "Microsoft.Commerce/UsageAggregate",

"properties": {
"subscriptionId":"sub1",
"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"

}
},

...

Dettagli della risposta

Parametro Descrizione
id ID univoco dell'aggregazione dell'utilizzo.
name Nome dell'aggregazione dell'utilizzo.
tipo Definizione della risorsa.
subscriptionId Identificatore di sottoscrizione dell'utente di Azure.
usageStartTime Ora di inizio in formato UTC del bucket di utilizzo a cui appartiene questa aggregazione dell'utilizzo.
usageEndTime Ora di fine in formato UTC del bucket di utilizzo a cui appartiene questa aggregazione dell'utilizzo.
Instancedata Coppie chiave-valore dei dettagli dell'istanza (in un nuovo formato):
resourceUri: ID risorsa completo, inclusi i gruppi di risorse e il nome dell'istanza.
location: area in cui è stato eseguito il servizio.
tag: tag di risorse specificati dall'utente.
additionalInfo: altre informazioni sulla risorsa utilizzata. Ad esempio, versione del sistema operativo o tipo di immagine.
quantity Risorse utilizzate in questo intervallo di tempo.
meterId ID univoco per la risorsa utilizzata (chiamata anche ResourceID).

Passaggi successivi