Partilhar via


API de utilização do recurso do fornecedor

O termo fornecedor aplica-se ao administrador de serviços e a quaisquer fornecedores delegados. Os operadores do Azure Stack Hub e os fornecedores delegados podem utilizar a API de utilização do fornecedor para ver a utilização dos respetivos inquilinos diretos. Por exemplo, conforme mostrado no diagrama seguinte, p0 pode chamar a API do fornecedor para obter informações de utilização direta em P1 e P2 e P1 pode pedir informações de utilização em P3 e P4.

Modelo conceptual da hierarquia do fornecedor

Referência de chamadas à API

Pedir

O pedido obtém detalhes de consumo para as subscrições pedidas e para o período de tempo pedido. Não existe nenhum corpo do pedido.

Esta API de utilização é uma API de fornecedor, pelo que o autor da chamada tem de ter atribuída uma função de Proprietário, Contribuidor ou Leitor na subscrição do fornecedor.

Método URI do pedido
GET 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}

Argumentos

Argumento Description
armendpoint O Azure Resource Manager ponto final do ambiente do Azure Stack Hub. A convenção do Azure Stack Hub é que o nome do ponto final do Azure Resource Manager está no formato https://adminmanagement.{domain-name}. Por exemplo, para o Azure Stack Development Kit (ASDK), se o nome de domínio for local.azurestack.external, o ponto final Resource Manager é https://adminmanagement.local.azurestack.external.
subId ID da subscrição do utilizador que faz a chamada.
reportedStartTime Hora de início da consulta. O valor de DateTime deve estar em Hora Universal Coordenada (UTC) e no início da hora; por exemplo, 13:00. Para agregação diária, defina este valor como MEIA-noite UTC. O formato é ISO 8601 de escape; por exemplo, 2015-06-16T18%3a53%3a11%2b00%3a00Z, para %3a onde os dois pontos são escapados e o sinal de adição é escapado para %2b que seja compatível com URI.
reportedEndTime Hora de fim da consulta. As restrições que se aplicam também a reportedStartTime este argumento. O valor de reportedEndTime não pode ser no futuro nem na data atual. Se for, o resultado está definido como "A processar não está concluído".
aggregationGranularity Parâmetro opcional que tem dois valores potenciais discretos: diariamente e por hora. Como os valores sugerem, um devolve os dados em granularidade diária e o outro é uma resolução por hora. A opção diária é a predefinição.
subscriberId ID da Subscrição. Para obter dados filtrados, é necessário o ID de subscrição de um inquilino direto do fornecedor. Se não for especificado nenhum parâmetro de ID de subscrição, a chamada devolve dados de utilização para todos os inquilinos diretos do fornecedor.
api-version Versão do protocolo utilizado para fazer este pedido. Este valor está definido como 2015-06-01-preview.
continuationToken Token obtido da última chamada ao fornecedor de API de utilização. Este token é necessário quando uma resposta é superior a 1000 linhas. Funciona como um marcador para o progresso. Se o token não estiver presente, os dados são obtidos a partir do início do dia ou hora, com base na granularidade transmitida.

Resposta

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 resposta

Argumento Description
id ID exclusivo da agregação de utilização.
name Nome da agregação de utilização.
type Definição de recurso.
subscriptionId Identificador de subscrição do utilizador do Azure Stack Hub.
usageStartTime Hora de início UTC do registo de utilização ao qual esta agregação de utilização pertence.
usageEndTime Hora de fim UTC do registo de utilização ao qual esta agregação de utilização pertence.
instanceData Pares chave-valor de detalhes da instância (num novo formato):
resourceUri: ID de recurso completamente qualificado, que inclui os grupos de recursos e o nome da instância.
location: região na qual este serviço foi executado.
tags: etiquetas de recursos especificadas pelo utilizador.
additionalInfo: Mais detalhes sobre o recurso que foi consumido; por exemplo, a versão do SO ou o tipo de imagem.
quantity Quantidade de consumo de recursos que ocorreu neste período de tempo.
meterId ID exclusivo do recurso que foi consumido (também denominado ResourceID).

Obter informações de utilização

PowerShell

Para gerar os dados de utilização, deve ter recursos que estão a ser executados e ativamente a utilizar o sistema; por exemplo, uma máquina virtual ativa (VM) ou uma conta de armazenamento com alguns dados. Se não tiver a certeza se tem recursos em execução no Marketplace do Azure Stack Hub, implemente uma VM e verifique o painel de monitorização da VM para se certificar de que está em execução. Utilize os seguintes cmdlets do PowerShell para ver os dados de utilização:

  1. Instale o PowerShell para o Azure Stack Hub.

  2. Configure o utilizador do Azure Stack Hub ou o ambiente do PowerShell do operador Azure Stack Hub .

  3. Para obter os dados de utilização, chame o cmdlet Do PowerShell Get-AzsSubscriberUsage :

    Get-AzsSubscriberUsage -ReportedStartTime "2017-09-06T00:00:00Z" -ReportedEndTime "2017-09-07T00:00:00Z"
    

API REST

Pode recolher informações de utilização para subscrições eliminadas ao chamar o serviço Microsoft.Commerce.Administração.

Devolver toda a utilização do inquilino para os utilizadores ativos eliminados

Método URI do pedido
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&api-version=2015-06-01-preview

Devolver a utilização do inquilino eliminado ou ativo

Método URI do pedido
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce.Admin/subscriberUsageAggregates?reportedStartTime={start-time}&reportedEndTime={end-endtime}&aggregationGranularity=Hourly&subscriberId={subscriber-id}&api-version=2015-06-01-preview

Passos seguintes