API de uso de recurso de provedorProvider resource usage API

O provedor de termos aplica-se ao administrador de serviços e a qualquer provedor delegado.The term provider applies to the service administrator and to any delegated providers. Azure Stack operadores de Hub e provedores delegados podem usar a API de uso do provedor para exibir o uso de seus locatários diretos.Azure Stack Hub operators and delegated providers can use the provider usage API to view the usage of their direct tenants. Por exemplo, como mostrado no diagrama a seguir, P0 pode chamar a API do provedor para obter informações de uso direto em P1 e P2, e P1 pode chamar informações de uso em 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.

Modelo conceitual da hierarquia do provedor

Referência de chamada à APIAPI call reference

SolicitaçãoRequest

A solicitação Obtém detalhes de consumo para as assinaturas solicitadas e para o período de tempo solicitado.The request gets consumption details for the requested subscriptions and for the requested time frame. Não há corpo de solicitação.There's no request body.

Essa API de uso é uma API de provedor, portanto, o chamador deve receber uma função de proprietário , colaborador ou leitor na assinatura do provedor.This usage API is a provider API, so the caller must be assigned an Owner , Contributor , or Reader role in the provider's subscription.

MétodoMethod URI da solicitaçãoRequest 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}

ArgumentosArguments

ArgumentoArgument DescriçãoDescription
armendpoint Azure Resource Manager ponto de extremidade de seu ambiente de Hub de Azure Stack.Azure Resource Manager endpoint of your Azure Stack Hub environment. A Convenção de Hub de Azure Stack é que o nome do ponto de extremidade de Azure Resource Manager está no 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}. Por exemplo, para o Kit de Desenvolvimento do Azure Stack (ASDK), se o nome de domínio for local. azurestack. external , o ponto de extremidade do Gerenciador de recursos será 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 da assinatura do usuário que faz a chamada.Subscription ID of the user who makes the call.
reportedStartTime Hora de início da consulta.Start time of the query. O valor de DateTime deve estar em UTC (tempo Universal Coordenado) e no início da hora; por exemplo, 13:00.The value for DateTime should be in Coordinated Universal Time (UTC) and at the beginning of the hour; for example, 13:00. Para agregação diária, defina esse valor como meia-noite UTC.For daily aggregation, set this value to UTC midnight. O formato é ISO 8601 de escape; por exemplo, 2015-06-16T18%3a53%3a11%2b00%3a00Z em que os dois pontos são ignorados %3a e o sinal de mais é ignorado para %2b que seja amigável para 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 Hora de término da consulta.End time of the query. As restrições que se aplicam a reportedStartTime também se aplicam a esse argumento.The constraints that apply to reportedStartTime also apply to this argument. O valor de reportedEndTime não pode ser no futuro ou na data atual.The value for reportedEndTime can't be either in the future, or the current date. Se for, o resultado será definido como "processamento não concluído".If it is, the result is set to "processing not complete."
aggregationGranularity Parâmetro opcional que tem dois valores potenciais discretos: diariamente e por hora.Optional parameter that has two discrete potential values: daily and hourly. Como os valores sugerem, um retorna os dados na granularidade diária e o outro é uma resolução por hora.As the values suggest, one returns the data in daily granularity, and the other is an hourly resolution. A opção diário é o padrão.The daily option is the default.
subscriberId ID da assinatura.Subscription ID. Para obter dados filtrados, é necessária a ID de assinatura de um locatário direto do provedor.To get filtered data, the subscription ID of a direct tenant of the provider is required. Se nenhum parâmetro de ID de assinatura for especificado, a chamada retornará dados de uso para todos os locatários diretos do provedor.If no subscription ID parameter is specified, the call returns usage data for all the provider's direct tenants.
api-version Versão do protocolo usado para fazer esta solicitação.Version of the protocol that's used to make this request. Esse valor é configurado para 2015-06-01-preview.This value is set to 2015-06-01-preview.
continuationToken Token recuperado da última chamada para o provedor de API de uso.Token retrieved from the last call to the usage API provider. Esse token é necessário quando uma resposta é maior que 1.000 linhas.This token is needed when a response is greater than 1,000 lines. Ele atua como um indicador do progresso.It acts as a bookmark for the progress. Se o token não estiver presente, os dados serão recuperados do início do dia ou da hora, com base na granularidade passada.If the token isn't present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

RespostaResponse

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"

}
},

. . .

Detalhes da respostaResponse details

ArgumentoArgument DescriçãoDescription
id ID exclusiva da agregação de uso.Unique ID of the usage aggregate.
name Nome da agregação de uso.Name of the usage aggregate.
type Definição de recurso.Resource definition.
subscriptionId Identificador de assinatura do usuário do hub de Azure Stack.Subscription identifier of the Azure Stack Hub user.
usageStartTime Hora de início UTC do Bucket de uso ao qual essa agregação de uso pertence.UTC start time of the usage bucket to which this usage aggregate belongs.
usageEndTime Hora de término UTC do Bucket de uso ao qual essa agregação de uso pertence.UTC end time of the usage bucket to which this usage aggregate belongs.
instanceData Pares de chave-valor dos detalhes da instância (em um novo formato):Key-value pairs of instance details (in a new format):
resourceUri: ID de recurso totalmente qualificado, que inclui os grupos de recursos e o nome da instância.resourceUri: Fully qualified resource ID, which includes the resource groups and the instance name.
location: Região em que este serviço foi executado.location: Region in which this service was run.
tags: Marcas de recurso que são especificadas pelo usuário.tags: Resource tags that are specified by the user.
additionalInfo: Mais detalhes sobre o recurso que foi consumido; por exemplo, a versão do sistema operacional ou o tipo de imagem.additionalInfo: More details about the resource that was consumed; for example, the OS version or image type.
quantity Quantidade de consumo de recursos que ocorreu neste intervalo de tempo.Amount of resource consumption that occurred in this time frame.
meterId ID exclusiva para o recurso que foi consumido (também chamado ResourceID ).Unique ID for the resource that was consumed (also called ResourceID).

Recuperar informações de usoRetrieve usage information

PowerShellPowerShell

Para gerar os dados de uso, você deve ter recursos que estão executando e usando ativamente o sistema; por exemplo, uma VM (máquina virtual) ativa ou uma conta de armazenamento que contém alguns dados.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 você não tiver certeza se tem algum recurso em execução no Marketplace do hub de Azure Stack, implante uma VM e verifique a folha de monitoramento da VM para verificar se ela está em execução.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. Use os seguintes cmdlets do PowerShell para exibir os dados de uso:Use the following PowerShell cmdlets to view the usage data:

  1. Instale o PowerShell para Azure Stack Hub.Install PowerShell for Azure Stack Hub.

  2. Configure o usuário do hub de Azure Stack ou o ambiente do PowerShell do operador de Hub de Azure Stack .Configure the Azure Stack Hub user or the Azure Stack Hub operator PowerShell environment.

  3. Para recuperar os dados de uso, chame o cmdlet Get-AzsSubscriberUsage do PowerShell: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

Você pode coletar informações de uso para assinaturas excluídas chamando o serviço Microsoft. Commerce. admin .You can collect usage information for deleted subscriptions by calling the Microsoft.Commerce.Admin service.

Retornar todo o uso de locatário para excluído para usuários ativosReturn all tenant usage for deleted for active users

MétodoMethod URI da solicitaçãoRequest URI
GETGET https://{armendpoint}/subscriptions/{subId}/providersMicrosoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview

Uso de retorno para o locatário excluído ou ativoReturn usage for deleted or active tenant

MétodoMethod URI da solicitaçãoRequest 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

Próximas etapasNext steps