Utilizzo delle risorse API tenantTenant Resource Usage API

Un tenant può utilizzare l'API Tenant per visualizzare i dati di utilizzo delle risorse del tenant.A tenant can use the Tenant API to view the tenant’s own resource usage data. Questa API è coerenza con l'API di utilizzo di Azure (attualmente in anteprima privata).This API is consistent with the Azure Usage API (currently in private preview).

È possibile utilizzare il cmdlet di Windows PowerShell Get UsageAggregates per ottenere dati di utilizzo, ad esempio in Azure.You can use the Windows PowerShell cmdlet Get-UsageAggregates to get usage data like in Azure.

Chiamata APIAPI call

RichiestaRequest

La richiesta ottiene i dettagli di utilizzo per le sottoscrizioni di richieste e per l'intervallo di tempo richiesto.The request gets consumption details for the requested subscriptions and for the requested time frame. Non vi è alcun corpo della richiesta.There is no request body.

MetodoMethod URI della richiestaRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version= 2015-06-01-preview & continuationToken = {valore del token}https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

ArgomentiArguments

ArgomentoArgument DescrizioneDescription
ArmendpointArmendpoint Endpoint di gestione delle risorse di Azure dell'ambiente dello Stack di Azure.Azure Resource Manager endpoint of your Azure Stack environment. La convenzione di Stack di Azure è che il nome dell'endpoint di gestione risorse di Azure è nel formato https://management.{domain-name}.The Azure Stack convention is that the name of Azure Resource Manager endpoint is in the format https://management.{domain-name}. Ad esempio, per il kit di sviluppo, il nome di dominio è local.azurestack.external, quindi l'endpoint di gestione risorse è https://management.local.azurestack.external.For example, for the development kit, the domain name is local.azurestack.external, then the Resource Manager endpoint is https://management.local.azurestack.external.
subIdsubId ID sottoscrizione dell'utente che effettua la chiamata.Subscription ID of the user who is making the call. È possibile utilizzare questa API solo per query per l'utilizzo di una singola sottoscrizione.You can use this API only to query for a single subscription’s usage. Provider possono utilizzare l'API di utilizzo risorse di Provider per l'utilizzo di query per tutti i tenant.Providers can use the Provider Resource Usage API to query usage for all tenants.
reportedStartTimereportedStartTime Ora di inizio della query.Start time of the query. Il valore per DateTime deve essere in formato UTC e all'inizio dell'ora, ad esempio, 13:00.The value for DateTime should be in UTC and at the beginning of the hour, for example, 13:00. Per l'aggregazione giornaliera, impostare questo valore alla mezzanotte ora UTC.For daily aggregation, set this value to UTC midnight. Il formato è escape ISO 8601, ad esempio 2015-06-16T18% 3a53% 3a11% 2b00% 3a00Z, due punti in cui viene sottoposta a escape a % 3a e più in modo che sia descrittivo URI alla versione 2b % di escape.The format is escaped ISO 8601, for example, 2015-06-16T18%3a53%3a11%2b00%3a00Z, where colon is escaped to %3a and plus is escaped to %2b so that it is URI friendly.
reportedEndTimereportedEndTime Ora di fine della query.End time of the query. I vincoli che si applicano a reportedStartTime si applicano anche a questo argomento.The constraints that apply to reportedStartTime also apply to this argument. Il valore per reportedEndTime non può essere in futuro.The value for reportedEndTime cannot be in the future.
aggregationGranularityaggregationGranularity Parametro facoltativo che dispone di due valori potenziali discreti: giornaliera e oraria.Optional parameter that has two discrete potential values: daily and hourly. Come suggeriscono i valori, uno restituisce i dati nella granularità giornaliera e l'altro è una risoluzione oraria.As the values suggest, one returns the data in daily granularity, and the other is an hourly resolution. L'opzione giornaliera è il valore predefinito.The daily option is the default.
versione dell'APIapi-version Versione del protocollo utilizzato per effettuare questa richiesta.Version of the protocol that is used to make this request. È necessario utilizzare 2015-06-01-preview.You must use 2015-06-01-preview.
continuationTokencontinuationToken Token recuperato dall'ultima chiamata al provider di API di utilizzo.Token retrieved from the last call to the Usage API provider. Questo token è necessaria quando una risposta è maggiore di 1.000 righe e funge da un segnalibro per lo stato di avanzamento.This token is needed when a response is greater than 1,000 lines and it acts as a bookmark for progress. Se non è presente, i dati vengono recuperati dall'inizio del giorno o ora, in base al livello di dettaglio passati.If not present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

ResponseResponse

OTTIENI /subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00 & reportedEndTime = 2015-06-01T00% 3a00% 3a00% 2b00% 3a00 & aggregationGranularity = giornaliera & api-version = 1.0GET /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 rispostaResponse details

ArgomentoArgument DescrizioneDescription
idid ID univoco della funzione di aggregazione di utilizzoUnique ID of the usage aggregate
nomename Nome della funzione di aggregazione di utilizzoName of the usage aggregate
typetype Definizione di risorsaResource definition
subscriptionIdsubscriptionId Identificatore della sottoscrizione dell'utente di AzureSubscription identifier of the Azure user
usageStartTimeusageStartTime UTC ora di inizio del bucket di utilizzo a cui appartiene questa aggregazione di utilizzoUTC start time of the usage bucket to which this usage aggregate belongs
usageEndTimeusageEndTime UTC ora di fine dell'intervallo di utilizzo a cui appartiene questa aggregazione di utilizzoUTC end time of the usage bucket to which this usage aggregate belongs
instanceDatainstanceData Coppie chiave-valore di dettagli di istanze (in un nuovo formato):Key-value pairs of instance details (in a new format):
resourceUri: ID di risorsa, inclusi gruppi di risorse e il nome di istanza completoresourceUri: Fully qualified resource ID, including resource groups and instance name
percorso: area in cui è stato eseguito il serviziolocation: Region in which this service was run
tag: i tag delle risorse specificate dall'utentetags: Resource tags that the user specifies
additionalInfo: ulteriori informazioni sulle risorse che è stata utilizzata, ad esempio, il tipo di versione o l'immagine del sistema operativoadditionalInfo: More details about the resource that was consumed, for example, OS version or image type
quantitàquantity Quantità di utilizzo delle risorse che si sono verificati in questo periodo di tempoAmount of resource consumption that occurred in this time frame
ID misuratoremeterId ID univoco per la risorsa che è stata utilizzata (detto anche ResourceID)Unique ID for the resource that was consumed (also called ResourceID)

Passaggi successiviNext steps

API di utilizzo delle risorse dei providerProvider resource usage API

Domande frequenti relative all'usoUsage-related FAQ