Compartilhar via

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

  • Artigo

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

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

Chamada à API

Solicitar

A solicitação obtém detalhes de consumo para as assinaturas solicitadas e para o período solicitado. Não há um corpo da 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 do Azure Resource Manager está no formato https://management.{domain-name}. Por exemplo, para o kit de desenvolvimento, o nome de domínio é local.azurestack.external, então o ponto de extremidade do Resource Manager é https://management.local.azurestack.external.
subId ID de assinatura do usuário que está fazendo a chamada. Você pode usar essa API apenas 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 é ISO 8601 escapado; por exemplo, 2015-06-16T18%3a53%3a11%2b00%3a00Z, em que os dois pontos são escapados para %3a e mais são escapados para %2b para que seja compatível com 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.
agregaçãoGranularidade Parâmetro opcional que possui dois valores potenciais discretos: diário e horário. 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 marcador para o progresso. Se não estiver presente, os dados serão recuperados desde o 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.
usoStartTime 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 de chave-valor de detalhes de instância (em um novo formato):
resourceUri: ID de recurso totalmente qualificado, incluindo grupos de recursos e nome da instância.
location: região em que esse serviço foi executado.
tags: tags de recursos especificadas pelo usuário.
additionalInfo: Mais detalhes sobre o recurso que foi consumido. Por exemplo, versão do sistema operacional ou tipo de imagem.
quantity A quantidade de consumo de recursos que ocorreu neste período.
meterId ID exclusiva do recurso que foi consumido (também chamado de ResourceID).

Próximas etapas