API di utilizzo delle risorse dei providerProvider resource usage API

Il termine provider si applica all'amministratore del servizio e a tutti i provider delegati.The term provider applies to the service administrator and to any delegated providers. Gli operatori dell'hub Azure Stack e i provider delegati possono usare l'API di utilizzo del provider per visualizzare l'utilizzo dei rispettivi tenant diretti.Azure Stack Hub operators and delegated providers can use the provider usage API to view the usage of their direct tenants. Ad esempio, come illustrato nel diagramma seguente, P0 può chiamare l'API del provider per ottenere informazioni sull'utilizzo diretto su P1 e P2 e P1 può chiamare per informazioni sull'utilizzo su P3 e 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.

Modello concettuale della gerarchia del provider

Informazioni di riferimento sulle chiamate APIAPI call reference

RichiestaRequest

La richiesta ottiene i dettagli sul consumo 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. Nessun corpo della richiesta.There's no request body.

Questa API di utilizzo è un'API del provider, quindi al chiamante deve essere assegnato un ruolo proprietario , collaboratore o lettore 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 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-preview&continuationToken={token-value}

ArgomentiArguments

ArgomentoArgument DescrizioneDescription
armendpoint Azure Resource Manager endpoint dell'ambiente dell'hub Azure Stack.Azure Resource Manager endpoint of your Azure Stack Hub environment. La convenzione dell'hub Azure Stack è che il nome dell'endpoint Azure Resource Manager è nel formato 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}. Per il Azure Stack Development Kit (Gabriele), ad esempio, se il nome di dominio è local. azurestack. External , l'endpoint gestione risorse è 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 ID sottoscrizione dell'utente che effettua la chiamata.Subscription ID of the user who makes the call.
reportedStartTime Ora di inizio della query.Start time of the query. Il valore di DateTime deve essere in formato UTC (Coordinated Universal Time) 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 su UTC mezzanotte.For daily aggregation, set this value to UTC midnight. Il formato è preceduto da un carattere di escape ISO 8601; ad esempio, 2015-06-16T18%3a53%3a11%2b00%3a00Z , dove i due punti sono preceduti da un carattere di escape %3a e il segno più viene sottoposto a escape in %2b modo che sia adatto all'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 Ora di fine della query.End time of the query. I vincoli applicabili a si reportedStartTime applicano anche a questo argomento.The constraints that apply to reportedStartTime also apply to this argument. Il valore di reportedEndTime non può essere in futuro o in una data corrente.The value for reportedEndTime can't be either in the future, or the current date. In caso contrario, il risultato viene impostato su "elaborazione non completata".If it is, the result is set to "processing not complete."
aggregationGranularity Parametro facoltativo con due valori potenziali discreti: giornaliera e oraria.Optional parameter that has two discrete potential values: daily and hourly. Come suggerito dai 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 è l'impostazione predefinita.The daily option is the default.
subscriberId 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 non viene specificato alcun parametro ID sottoscrizione, la chiamata restituisce i dati di utilizzo per tutti 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-version Versione del protocollo usato 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.
continuationToken Token recuperato dall'ultima chiamata al provider API di utilizzo.Token retrieved from the last call to the usage API provider. Questo token è necessario quando una risposta è maggiore di 1.000 righe.This token is needed when a response is greater than 1,000 lines. Funge da segnalibro per lo stato di avanzamento.It acts as a bookmark for the progress. Se il token non è presente, i dati vengono recuperati a partire dall'inizio del giorno o dell'ora, in base alla granularità passata.If the token isn't present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

RispostaResponse

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"

}
},

. . .

Dettagli rispostaResponse details

ArgomentoArgument DescrizioneDescription
id ID univoco dell'aggregazione Usage.Unique ID of the usage aggregate.
name Nome dell'aggregazione Usage.Name of the usage aggregate.
type Definizione di risorsa.Resource definition.
subscriptionId Identificatore della sottoscrizione dell'utente dell'hub Azure Stack.Subscription identifier of the Azure Stack Hub user.
usageStartTime Ora UTC di inizio del bucket di utilizzo a cui appartiene questa aggregazione di utilizzo.UTC start time of the usage bucket to which this usage aggregate belongs.
usageEndTime Ora UTC di fine del bucket di utilizzo a cui appartiene questa aggregazione di utilizzo.UTC end time of the usage bucket to which this usage aggregate belongs.
instanceData Coppie chiave-valore dei dettagli dell'istanza (in un nuovo formato):Key-value pairs of instance details (in a new format):
resourceUri: ID di risorsa completo, 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.
location: Area in cui è stato eseguito il servizio.location: Region in which this service was run.
tags: Tag delle risorse specificati dall'utente.tags: Resource tags that are specified by the user.
additionalInfo: Ulteriori informazioni sulla risorsa utilizzata; ad esempio, la versione del sistema operativo o il tipo di immagine.additionalInfo: More details about the resource that was consumed; for example, the OS version or image type.
quantity Quantità di consumo di risorse che si è verificata in questo intervallo di tempo.Amount of resource consumption that occurred in this time frame.
meterId ID univoco per la risorsa utilizzata (anche chiamata ResourceID ).Unique ID for the resource that was consumed (also called ResourceID).

Recuperare le informazioni sull'utilizzoRetrieve usage information

PowerShellPowerShell

Per generare i dati di utilizzo, è necessario disporre di risorse in esecuzione e di utilizzo attivo del sistema; ad esempio, una macchina virtuale (VM) attiva o un account di archiviazione contenente alcuni dati.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. Se non si è certi che siano in esecuzione risorse nel Marketplace dell'hub Azure Stack, distribuire una macchina virtuale e verificare il pannello monitoraggio della macchina virtuale per assicurarsi che sia in esecuzione.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. Usare 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 l'Hub Azure stack.Install PowerShell for Azure Stack Hub.

  2. Configurare l'utente dell'hub Azure stack o l'ambiente PowerShell dell' operatore Azure stack Hub .Configure the Azure Stack Hub user or the Azure Stack Hub operator PowerShell environment.

  3. Per recuperare i dati di utilizzo, chiamare il cmdlet di PowerShell Get-AzsSubscriberUsage :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"
    

API RESTREST API

È possibile raccogliere informazioni sull'utilizzo per le sottoscrizioni eliminate chiamando il servizio Microsoft. Commerce. admin .You can collect usage information for deleted subscriptions by calling the Microsoft.Commerce.Admin service.

Restituisce tutto l'utilizzo del tenant per eliminato per gli utenti attiviReturn all tenant usage for deleted for active users

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

Restituisci utilizzo per tenant eliminato o attivoReturn usage for deleted or active tenant

MetodoMethod URI richiestaRequest 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

Passaggi successiviNext steps