Referência da API de uso de recursos de locatário

  • Artigo

Um locatário pode usar as APIs de locatário para exibir os próprios dados de uso de recursos do locatário. Essas APIs são consistentes com as APIs de uso do Azure.

Você pode usar o cmdlet Windows PowerShell Get-UsageAggregates para obter dados de uso, assim como no Azure.

Chamada à API

Solicitação

A solicitação obtém detalhes de consumo para as assinaturas solicitadas e para o período solicitado. Não há nenhum corpo de solicitação.

Método URI da solicitação
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Parâmetros

Parâmetro Descrição
Armendpoint Ponto de extremidade do Azure Resource Manager do seu ambiente do Azure Stack Hub. A convenção do Azure Stack Hub é que o nome do ponto de extremidade Resource Manager do Azure está no formato https://management.{domain-name}. Por exemplo, para o kit de desenvolvimento, o nome de domínio é local.azurestack.external e, em seguida, o ponto de extremidade Resource Manager é https://management.local.azurestack.external.
subId ID da assinatura do usuário que está fazendo a chamada. Você só pode usar essa API para consultar o uso de uma única assinatura. Os provedores podem usar a API de uso de recursos do provedor para consultar o uso de todos os locatários.
reportedStartTime A hora de início da consulta. O valor de DateTime deve estar em UTC e no início da hora; por exemplo, 13:00. Para a agregação diária, defina esse valor como meia-noite UTC. O formato tem escape da ISO 8601; por exemplo, 2015-06-16T18%3a53%3a11%2b00%3a00Z, em que dois-pontos é escapado para %3a e mais é escapado para %2b para que seja amigável ao URI.
reportedEndTime A hora de término da consulta. As restrições que se aplicam a reportedStartTime também se aplicam a esse parâmetro. O valor de reportedEndTime não pode estar no futuro.
aggregationGranularity Parâmetro opcional que tem dois valores potenciais discretos: diariamente e por hora. Como os valores sugerem, um retorna os dados em granularidade diária e o outro é uma resolução por hora. A opção diária é o padrão.
api-version Versão do protocolo usado para fazer essa solicitação. Você deve usar 2015-06-01-preview.
continuationToken Token recuperado da última chamada para o provedor de API de uso. Esse token é necessário quando uma resposta tem mais que 1.000 linhas. Ele atua como um indicador para o progresso. Se não estiverem presentes, os dados serão recuperados do início do dia ou da hora, com base na granularidade passada.

Resposta

GET
/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"

}
},

...

Detalhes da resposta

Parâmetro Descrição
id ID exclusiva da agregação de uso.
name Nome da agregação de uso.
tipo Definição de recurso.
subscriptionId Identificador de assinatura do usuário do Azure.
usageStartTime Hora de início UTC do bucket de uso ao qual essa agregação de uso pertence.
usageEndTime Hora de término UTC do bucket de uso ao qual essa agregação de uso pertence.
Instancedata Pares chave-valor de detalhes da instância (em um novo formato):
resourceUri: ID de recurso totalmente qualificado, incluindo grupos de recursos e nome da instância.
location: região na qual esse serviço foi executado.
tags: marcas de recurso especificadas pelo usuário.
additionalInfo: mais detalhes sobre o recurso que foi consumido. Por exemplo, versão do sistema operacional ou tipo de imagem.
quantidade A quantidade de consumo de recursos que ocorreu neste período.
meterId ID exclusiva para o recurso que foi consumido (também chamado de ResourceID).

Próximas etapas