API di utilizzo delle risorse dei providerProvider resource usage API

Il termine provider si applica all'amministratore del servizio e a qualsiasi provider di delegati.The term provider applies to the service administrator and to any delegated providers. Gli operatori di Stack Azure e provider delegati possono utilizzare l'utilizzo del provider di API per visualizzare l'utilizzo dei propri tenant diretto.Azure Stack operators and delegated providers can use the provider usage API to view the usage of their direct tenants. Ad esempio, come illustrato nel diagramma, P0 può chiamare l'API per ottenere informazioni sul P1 utilizzo del provider e l'utilizzo diretto del P2 e P1 può chiamare per informazioni sull'utilizzo in P3 e P4.For example, as shown in the diagram, P0 can call the provider API to get usage information on P1's and P2's direct usage, and P1 can call for usage information on P3 and P4.

Modello concettuale della gerarchia di provider

Riferimento API chiamataAPI call reference

RichiestaRequest

La richiesta ottiene i dettagli di utilizzo per le sottoscrizioni 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.

Questo utilizzo API è un provider di API, in modo che il chiamante deve essere assegnato un ruolo di proprietario, collaboratore o Reader nella sottoscrizione del provider.This usage API is a provider API, so the caller must be assigned an Owner, Contributor, or Reader role in the provider’s subscription.

MetodoMethod URI della richiestaRequest 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-Anteprima & continuationToken = {token-value}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}

ArgomentiArguments

ArgomentoArgument DescrizioneDescription
armendpointarmendpoint Endpoint di gestione risorse 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 Azure Resource Manager sia nel formato https://adminmanagement.{domain-name}.The Azure Stack convention is that the name of the Azure Resource Manager endpoint is in the format https://adminmanagement.{domain-name}. Ad esempio, per il kit di sviluppo, se il nome di dominio local.azurestack.external, quindi l'endpoint di gestione risorse è https://adminmanagement.local.azurestack.external.For example, for the development kit, if the domain name is local.azurestack.external, then the Resource Manager endpoint is https://adminmanagement.local.azurestack.external.
subIdsubId ID sottoscrizione dell'utente che effettua la chiamata.Subscription ID of the user who makes the call.
reportedStartTimereportedStartTime Ora di inizio della query.Start time of the query. Il valore per DateTime deve essere nel formato Coordinated Universal Time (UTC) e all'inizio dell'ora, ad esempio 13.00.The value for DateTime should be in Coordinated Universal Time (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.The format is escaped ISO 8601. Ad esempio 2015-06-16T18% 3a53% 3a11% 2b00% 3a00Z, in cui i due punti di escape per % 3a e il segno più viene sottoposto a escape a % 2b in modo che risulti URI descrittivo.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.
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 successiva alla data o alla data corrente.The value for reportedEndTime can't be in the future or the current date. In caso affermativo, il risultato è impostato su "durante l'elaborazione non completato."If it is, the result is set to "processing not complete."
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 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 giornaliero è il valore predefinito.The daily option is the default.
subscriberIdsubscriberId l'ID sottoscrizione.Subscription ID. Per ottenere i dati filtrati, è necessario l'ID sottoscrizione di un tenant diretto del provider.To get filtered data, the subscription ID of a direct tenant of the provider is required. Se si specifica alcun parametro di ID sottoscrizione, la chiamata restituisce i dati di utilizzo per i tenant diretti del provider.If no subscription ID parameter is specified, the call returns usage data for all the provider’s direct tenants.
api-versionapi-version Versione del protocollo utilizzato per effettuare questa richiesta.Version of the protocol that's used to make this request. Questo valore è impostato su 2015-06-01-preview.This value is set to 2015-06-01-preview.
continuationTokencontinuationToken Token recuperato all'ultima chiamata al provider di utilizzo API.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 the progress. Se il token non è presente, i dati vengono recuperati dall'inizio del giorno o ora, in base alla granularità passati.If the token is not present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

RispostaResponse

OTTIENI /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 = ogni giorno & subscriberId = sub1.1 & api-version = 1.0GET /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"

}
},

…

Dettagli della rispostaResponse details

ArgomentoArgument DescrizioneDescription
idid ID univoco della funzione di aggregazione di utilizzo.Unique ID of the usage aggregate.
nomename Nome della funzione di aggregazione di utilizzo.Name of the usage aggregate.
typetype Definizione di risorsa.Resource definition.
subscriptionIdsubscriptionId Identificatore della sottoscrizione dell'utente dello Stack di Azure.Subscription identifier of the Azure Stack user.
usageStartTimeusageStartTime UTC ora di inizio il bucket di utilizzo a cui appartiene questa aggregazione di utilizzo.UTC 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 utilizzo.UTC 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: completo ID di risorsa, che include i gruppi di risorse e il nome dell'istanza.resourceUri: Fully qualified resource ID, which includes the resource groups and the instance name.
percorso: area in cui è stato eseguito il servizio.location: Region in which this service was run.
tag: i tag delle risorse specificate dall'utente.tags: Resource tags that are specified by the user.
additionalInfo: ulteriori dettagli sulla risorsa che è stata utilizzata, ad esempio, il tipo di versione o l'immagine del sistema operativo.additionalInfo: More details about the resource that was consumed, for example, the OS version or image type.
Quantitàquantity Quantità di utilizzo delle risorse che si sono verificati in questo periodo di tempo.Amount of resource consumption that occurred in this time frame.
meterIdmeterId ID univoco per la risorsa che è stata utilizzata (chiamato anche ResourceID).Unique ID for the resource that was consumed (also called ResourceID).

Recuperare le informazioni sull'utilizzoRetrieve usage information

Per generare i dati di utilizzo, è necessario disporre di risorse che sono in esecuzione e che usano attivamente il sistema, ad esempio, una macchina virtuale attiva o un account di archiviazione che contiene alcuni dati e così via. Se non si è certi se si ha delle risorse in esecuzione in Azure Marketplace di Stack, distribuire una macchina virtuale (VM) e verifica la macchina virtuale monitoraggio pannello per assicurarsi che è in esecuzione.To generate the usage data, you should have resources that are running and actively using the system, For example, an active virtual machine, or a storage account containing some data etc. If you’re not sure whether you have any resources running in Azure Stack Marketplace, deploy a virtual machine (VM), and verify the VM monitoring blade to make sure it’s running. Utilizzare i cmdlet di PowerShell seguenti per visualizzare i dati di utilizzo:Use the following PowerShell cmdlets to view the usage data:

  1. Installare PowerShell per Azure dello Stack.Install PowerShell for Azure Stack.
  2. Configurare l'utente di Azure Stack o il dell'operatore Azure Stack ambiente di PowerShellConfigure the Azure Stack user's or the Azure Stack operator's PowerShell environment
  3. Per recuperare i dati di utilizzo, usare il Get-UsageAggregates cmdlet di PowerShell:To retrieve the usage data, use the Get-UsageAggregates PowerShell cmdlet: powershell Get-UsageAggregates -ReportedStartTime "<Start time for usage reporting>" -ReportedEndTime "<end time for usage reporting>" -AggregationGranularity <Hourly or Daily>

Passaggi successiviNext steps

Utilizzo delle risorse tenant riferimento APITenant resource usage API reference

Domande frequenti relative all'usoUsage-related FAQ